Merge pull request #19 from tsotetsi/tf-18-setup-postgreSQL

TF 18 Setup postgre sql

Author: tsotetsi

backend/user_service/.envs/.local/postgres renamed to backend/user_service/.envs/.local/.postgres

@@ -1,13 +1,13 @@
 # POSTGRESQL DEV DATABASE
 # ---------------------------------------------------------
-POSTGRES_HOST=postgres
+POSTGRES_HOST=localhost
 POSTGRES_PORT=5432
-POSTGRES_DB=user_service
-POSTGRES_USER=dev
+POSTGRES_DB=user_service_db
+POSTGRES_USER=user_dev_local
 POSTGRES_PASSWORD=@changeMe1234
 
 # POSTGRESQL TEST DATABASE
 # ---------------------------------------------------------
 POSTGRES_DB_TEST=user_service_test
 POSTGRES_USER_TEST=postgres
-POSTGRES_PASSWORD_TEST=@changeMe1234
+POSTGRES_PASSWORD_TEST=@changeMe123

backend/user_service/.envs/.local/.userservice

@@ -5,5 +5,4 @@ IPYTHONDIR="/app/.ipython"
 
 DEBUG=1
 SECRET_KEY="django-insecure-abcdefghijklmnopqrstuvwxyz0123456789!@#$%^&*"
-DJANGO_ALLOWED_HOSTS=["*"]
 DJANGO_SETTINGS_MODULE=config.settings.local

backend/user_service/README.md

@@ -29,6 +29,21 @@
    - Install VS Code or PyCharm
    - Install Python extension
 
+4. **PostgreSQL**
+   - Install PostgreSQL from official site
+   - Create user and set the password
+   ```bash
+   # Use postgres user to create new user, depending on your setup.
+   psql -U postgres -h localhost
+   ```
+   ```sql
+   CREATE USER user_dev_local WITH PASSWORD 'your_password';
+   ALTER ROLE user_dev_local CREATEDB; -- Optional: Use can create databases.
+   CREATE DATABASE user_dev_local;
+   GRANT ALL PRIVILEGES ON DATABASE user_dev_local TO user_dev_local;
+   psql -U user_dev_local -d your_password -h localhost
+   ```
+
 ### Local Development
 
 1. Clone Repository
@@ -96,7 +111,21 @@
    ```bash
    kubectl rollout restart
    ```
-
+5. Connect to PostGreSQL inside the Pod
+   ```bash
+   kubectl exec -it postgres-c8c4f79bf-jkgbz -- /bin/bash
+   root@postgres-c8c4f79bf-jkgbz:/#  # No you are inside postgresql.
+   psql -U user_dev_local -d user_service_db
+   psql (14.15 (Debian 14.15-1.pgdg120+1)) # This means the instance is working.
+   ...
+   ```
+6. Other ways to check for services.
+   ```bash
+   apt update && apt install -y iputils-ping
+   ping postgres
+   telnet postgres 5432
+   nc -vz postgres 5432
+   ```
 ## Architecture
 - Event-Driven Architecture
 - Microservices Architecture

backend/user_service/compose/local/user-service/start

@@ -12,10 +12,17 @@ echo "Python version: $(python --version)"
 # NB: You can use a while loop here
 #     to wait for certain services
 #     be available.
+
+# Check for any django related issues.
+echo "Checking django related issues..."
+python manage.py check || {
+  echo "Checking django related issues failed..."
+  exit 1
+}
 # Database migrations with error checking
 echo "Checking database migrations..."
 python manage.py makemigrations || {
-    echo "Migration preparation failed"
+    echo "Migration preparation failed..."
     exit 1
 }
 
@@ -37,5 +44,4 @@ exec gunicorn config.wsgi:application --bind 0.0.0.0:8000 \
     --workers 3 \
     --log-level=info \
     --log-file=- \
-    --capture-output
-#python manage.py runserver 0.0.0.0:8000
+    --capture-output

backend/user_service/config/db.sqlite3

@@ -1,17 +1,19 @@
+import os
 from pathlib import Path
 
+from dotenv import load_dotenv
+
+
 # Build paths inside the project like this: BASE_DIR / 'subdir'.
 BASE_DIR = Path(__file__).resolve(strict=True).parent.parent.parent
 # Quick-start development settings - unsuitable for production
 # See https://docs.djangoproject.com/en/5.1/howto/deployment/checklist/
 
-# SECURITY WARNING: keep the secret key used in production secret!
-SECRET_KEY = 'django-insecure-thdv&w5!x!cx0kb+iu3yym_(u4_vqb+jzrd5i5r#%2x19q63nh'
-
-# SECURITY WARNING: don't run with debug turned on in production!
-DEBUG = True
+USER_SERVICE_ENV_PATH = os.path.join(BASE_DIR, '.envs', '.local', '.userservice')
+POSTGRES_ENV_PATH = os.path.join(BASE_DIR, '.envs', '.local', '.postgres')
 
-ALLOWED_HOSTS = []
+load_dotenv(USER_SERVICE_ENV_PATH)
+load_dotenv(POSTGRES_ENV_PATH)
 
 # TicketFlow Application definition.
 
@@ -70,7 +72,7 @@
 # ------------------------------------------------------------------------------
 # https://docs.djangoproject.com/en/dev/ref/settings/#authentication-backends
 AUTHENTICATION_BACKENDS = [
-    # Needed to login by username in Django admin, regardless of `allauth`
+    # Needed to log in by username in Django admin, regardless of `allauth`
     "django.contrib.auth.backends.ModelBackend",
 ]
 # https://docs.djangoproject.com/en/dev/ref/settings/#auth-user-model
@@ -82,13 +84,17 @@
 
 WSGI_APPLICATION = 'config.wsgi.application'
 
-# Database
-# https://docs.djangoproject.com/en/5.1/ref/settings/#databases
-
+# DATABASES
+# ------------------------------------------------------------------------------
+# https://docs.djangoproject.com/en/dev/ref/settings/#databases
 DATABASES = {
-    'default': {
-        'ENGINE': 'django.db.backends.sqlite3',
-        'NAME': BASE_DIR / 'db.sqlite3',
+    "default": {
+        "ENGINE": "django.db.backends.postgresql",
+        "NAME": os.getenv("POSTGRES_DB", "user_service_db"),
+        "USER": os.getenv("POSTGRES_USER", "user_dev_local"),
+        "PASSWORD": os.getenv("POSTGRES_PASSWORD", "@changeMe1234"),
+        "HOST": os.getenv("POSTGRES_HOST", "localhost"),
+        "PORT": os.getenv("POSTGRES_PORT", "5432"),
     }
 }
 

backend/user_service/config/settings/base.py

@@ -3,11 +3,10 @@
 # GENERAL
 # ------------------------------------------------------------------------------
 # https://docs.djangoproject.com/en/dev/ref/settings/#debug
-DEBUG = True
+DEBUG = os.getenv('DEBUG', 1)
 # https://docs.djangoproject.com/en/dev/ref/settings/#secret-key
-SECRET_KEY = "nJF7857vESYkIayySmQySmvPmumtfsttzIRhgy1bOvf3gNaYDeqW2G7Hvv7qAxxa"
+SECRET_KEY = os.getenv('SECRET_KEY', 'changeMeIfYouSeeThis')
 
 # https://docs.djangoproject.com/en/dev/ref/settings/#allowed-hosts
 # TODO: Set static IP address for minikube, minikube start --static=192.168.49.2
-# ALLOWED_HOSTS = ["localhost", "0.0.0.0", "127.0.0.1"]  # noqa: S104
-ALLOWED_HOSTS = ["*"]
+ALLOWED_HOSTS = ["localhost", "0.0.0.0", "127.0.0.1"]  # noqa: S104

backend/user_service/config/settings/local.py

@@ -1,5 +1,26 @@
+volumes:
+  userservice_local_postgres_data: {}
+  userservice_local_postgres_data_backups: {}
+
 services:
+  postgres-service:
+    image: postgres:latest
+    container_name: user_service_postgres_db
+    env_file:
+      - ./.envs/.local/.postgres
+    volumes:
+      - userservice_local_postgres_data:/var/lib/postgresql/data
+    ports:
+      - "5431:5431" # I have local instance postgres running.
+    healthcheck:
+      test: ["CMD-SHELL", "pg_isready -U user_dev_local -d user_service_db"]
+      interval: 5s
+      timeout: 5s
+      retries: 5
+
   user-service:
+    depends_on:
+      - postgres-service
     build:
       context: .
       dockerfile: ./compose/local/user-service/Dockerfile
@@ -9,4 +30,4 @@ services:
       - ./.envs/.local/.userservice
     ports:
       - '8000:8000'
-    command: /start
+    command: /start

backend/user_service/docker-compose.local.yml

@@ -0,0 +1,32 @@
+apiVersion: apps/v1
+kind: Deployment
+metadata:
+  name: postgres
+spec:
+  replicas: 1
+  selector:
+    matchLabels:
+      app: postgres
+  template:
+    metadata:
+      labels:
+        app: postgres
+    spec:
+      containers:
+        - name: postgres
+          image: postgres:14 # Use a stable PostgreSQL version
+          ports:
+            - containerPort: 5432
+          env:
+            - name: POSTGRES_USER
+              value: "user_dev_local"
+            - name: POSTGRES_PASSWORD
+              value: "@changeMe1234"
+            - name: POSTGRES_DB
+              value: "user_service_db"
+          volumeMounts:
+            - mountPath: "/var/lib/postgresql/data"
+              name: postgres-storage
+      volumes:
+        - name: postgres-storage
+          emptyDir: {}  # Replace with PersistentVolumeClaim for production

backend/user_service/k8s/postgres-deployment.yaml

@@ -0,0 +1,10 @@
+apiVersion: v1
+kind: Service
+metadata:
+  name: postgres
+spec:
+  ports:
+    - port: 5432
+  selector:
+    app: postgres
+    type: ClusterIP