Refactor PostgreSQL configuration and Helm chart setup for Kubernetes deployment

Author: mcqueide

.k8s/api-env.yaml

@@ -4,7 +4,7 @@ metadata:
   name: api-env
 data:
   SPRING_PROFILES_ACTIVE: "docker"
-  SPRING_DATASOURCE_URL: "jdbc:postgresql://db:5432/people"
+  SPRING_DATASOURCE_URL: "jdbc:postgresql://my-app-db:5432/people"
   SPRING_DATASOURCE_USERNAME: "people"
   SPRING_DATASOURCE_PASSWORD: "people"
   JAVA_OPTS: "-XX:+UseG1GC -XX:MaxRAMPercentage=75"

.k8s/postgres-pvc.yaml

@@ -0,0 +1,54 @@
+# K8S
+
+## Prerequisites
+
+- Kubernetes
+- Helm
+
+## Install Kubernetes with Kind
+
+1. You can use any Kubernetes cluster, or install [Kind](https://kind.sigs.k8s.io/docs/user/quick-start/#installation) in your Docker.
+
+2. Create cluster.
+
+```
+kind create cluster --config=.k8s/kind.yaml --name=kind
+```
+    
+3. Set kubectl content for the new created cluster.
+
+```
+kubectl cluster-info --context kind-kind
+```
+
+## Install Helm
+
+1. Follow the [Helm installation guide](https://helm.sh/docs/intro/install/).
+
+## Help Cheat Sheet
+
+```
+# Run tests to examine a chart and identify possible issues:
+helm lint helm/postgres 
+
+# Run a test installation to validate chart (p)
+helm template <name> helm/postgres --values helm/postgres/values.yaml --debug 
+
+# Run a test installation to validate chart (p)
+helm template <name> helm/postgres --dry-run --debug 
+
+# Install the chart
+helm install <name> helm/postgres
+
+# Install the chart in a specific namespace
+helm install <name> helm/postgres --namespace <namespace> 
+
+# Lists all of the releases for a specified namespace, uses current namespace context if namespace not specified
+helm list
+
+# Uninstalls a release from the current (default) namespace
+help uninstall <name> 
+
+# Uninstalls a release from the specified namespace
+helm uninstall <release-name> --namespace <namespace> 
+```

.k8s/postgres-secret.yaml

@@ -0,0 +1,15 @@
+name: postgres-deployment
+apiVersion: v2
+version: 0.1.0
+description: A Helm chart for deploying PostgreSQL database on Kubernetes
+type: application
+keywords:
+  - postgres
+  - database
+  - kubernetes
+maintainers:
+  - name: Your Name
+    email: your.email@example.com
+sources:
+  - https://github.com/your-repo/postgres-deployment
+dependencies: []

.k8s/postgres-service.yaml

@@ -1,49 +1,48 @@
 apiVersion: apps/v1
 kind: Deployment
 metadata:
-  name: people-api-postgres
+  name: {{ .Release.Name }}-db
   labels:
-    app: people-api-postgres
+    app: {{ .Release.Name }}-db
 spec:
   selector:
     matchLabels:
-      app: people-api-postgres
+      app: {{ .Release.Name }}-db
   template:
     metadata:
       labels:
-        app: people-api-postgres
+        app: {{ .Release.Name }}-db
     spec:
       containers:
         - name: db
-          image: postgres:17-alpine3.22
+          image: {{ .Values.container.image.repository }}:{{ .Values.container.image.tag }}
           ports:
             - containerPort: 5432
-              name: postgres
-          resources:
-            requests:
-              memory: "256Mi"
-              cpu: "250m"
-            limits:
-              memory: "512Mi"
-              cpu: "500m"
           env:
             - name: POSTGRES_DB
               valueFrom:
                 secretKeyRef:
-                  name: people-api-postgres-secret
+                  name: {{ .Release.Name }}-db-secret
                   key: POSTGRES_DB
             - name: POSTGRES_USER
               valueFrom:
                 secretKeyRef:
-                  name: people-api-postgres-secret
+                  name: {{ .Release.Name }}-db-secret
                   key: POSTGRES_USER
             - name: POSTGRES_PASSWORD
               valueFrom:
                 secretKeyRef:
-                  name: people-api-postgres-secret
+                  name: {{ .Release.Name }}-db-secret
                   key: POSTGRES_PASSWORD
+          resources:
+            requests:
+              memory: {{ .Values.container.resources.requests.memory }}
+              cpu: {{ .Values.container.resources.requests.cpu }}
+            limits:
+              memory: {{ .Values.container.resources.limits.memory }}
+              cpu: {{ .Values.container.resources.limits.cpu }}
           volumeMounts:
-            - name: postgres-storage
+            - name: {{ .Release.Name }}-storage
               mountPath: /var/lib/postgresql/data
           startupProbe:
             exec:
@@ -68,7 +67,6 @@ spec:
                 - pg_isready -U "$(POSTGRES_USER:-postgres)"
             periodSeconds: 20
       volumes:
-        - name: postgres-storage
+        - name: {{ .Release.Name }}-storage
           persistentVolumeClaim:
-            claimName: postgres-pvc
-        
+            claimName: {{ .Release.Name }}-pvc

README.K8S.md

@@ -0,0 +1,10 @@
+apiVersion: v1
+kind: PersistentVolumeClaim
+metadata:
+  name: {{ .Release.Name }}-pvc
+spec:
+  accessModes:
+    - {{ .Values.pvc.accessMode }}
+  resources:
+    requests:
+      storage: {{ .Values.pvc.size }}

helm/postgres/Chart.yaml

@@ -0,0 +1,9 @@
+apiVersion: v1
+kind: Secret
+metadata:
+  name: {{ .Release.Name }}-db-secret
+type: Opaque
+data:
+  POSTGRES_DB: {{ .Values.container.environment.POSTGRES_DB }}
+  POSTGRES_USER: {{ .Values.container.environment.POSTGRES_USER }}
+  POSTGRES_PASSWORD: {{ .Values.container.environment.POSTGRES_PASSWORD }}

.k8s/postgres-deployment.yaml helm/postgres/templates/deployment.yaml.k8s/postgres-deployment.yaml renamed to helm/postgres/templates/deployment.yaml

@@ -0,0 +1,14 @@
+apiVersion: v1
+kind: Service
+metadata:
+  name: {{ .Release.Name }}-db
+  labels:
+    app: {{ .Release.Name }}-db
+spec:
+  selector:
+    app: {{ .Release.Name }}-db
+  type: {{ .Values.container.service.type }}
+  ports:
+    - port: {{ .Values.container.service.port }}
+      targetPort: {{ .Values.container.service.targetPort }}
+      protocol: TCP