KoPKB/QMS
2
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

DONE: pipeline cicd for backend

Browse Source
This commit is contained in:
ISMAIL MASSERAN
2026-07-23 11:31:17 +08:00
parent 85b31e9528
commit 523218faa5
10 changed files with 343 additions and 21 deletions
Download Patch File Download Diff File Expand all files Collapse all files
.gitea/workflows/be-deploy.yml
+112
View File
@@ -0,0 +1,112 @@
name: Deploy Backend to Production
# Manual production deploy — pulls pre-built backend image from the registry
on:
workflow_dispatch:
inputs:
image_tag:
description: "Docker image tag to deploy (commit SHA or version tag, e.g. v1.0.0)"
required: true
type: string
env:
BACKEND_IMAGE: git.koppkb.com/kopkb/qms-be
DEPLOY_DIR: /home/arrahn/Project/qms
jobs:
deploy:
runs-on: host
steps:
- name: Checkout repository
uses: actions/checkout@v4
with:
ref: ${{ inputs.image_tag }}
- name: Login to Docker registry
run: |
echo "${{ secrets.REGISTRY_PASSWORD }}" | \
docker login git.koppkb.com \
-u "${{ secrets.REGISTRY_USERNAME }}" \
--password-stdin
- name: Verify backend image exists in registry
run: |
set -e
IMAGE_TAG="${{ inputs.image_tag }}"
IMAGE="${BACKEND_IMAGE}:${IMAGE_TAG}"
echo "Checking if image exists: ${IMAGE}"
if ! docker manifest inspect "${IMAGE}" > /dev/null 2>&1; then
echo "ERROR: Image ${IMAGE} does not exist in registry!"
exit 1
fi
echo "✓ ${IMAGE} found"
- name: Pull backend image
run: |
set -e
IMAGE_TAG="${{ inputs.image_tag }}"
docker pull "${BACKEND_IMAGE}:${IMAGE_TAG}"
echo "✓ Image pulled successfully"
- name: Sync compose file and deploy
run: |
set -e
IMAGE_TAG="${{ inputs.image_tag }}"
mkdir -p "${DEPLOY_DIR}"
cp be/docker-compose.yml "${DEPLOY_DIR}/docker-compose.yml"
cd "${DEPLOY_DIR}"
if [ ! -f .env ]; then
echo "ERROR: ${DEPLOY_DIR}/.env is missing on the server"
echo "Create it from be/.env.example (or be/.env.production) before deploying."
exit 1
fi
export IMAGE_TAG
export BACKEND_IMAGE
docker compose -f docker-compose.yml pull backend
docker compose -f docker-compose.yml up -d --remove-orphans
echo "✓ Deployed IMAGE_TAG=${IMAGE_TAG}"
- name: Verify deployment
run: |
set -e
cd "${DEPLOY_DIR}"
echo "Waiting for services to start..."
sleep 15
for SERVICE in mysql backend; do
STATUS=$(docker compose -f docker-compose.yml ps --status running --format '{{.Name}}' "$SERVICE" 2>/dev/null || true)
if [ -z "$STATUS" ]; then
echo "ERROR: ${SERVICE} is not running"
docker compose -f docker-compose.yml ps
docker compose -f docker-compose.yml logs --tail=50 "$SERVICE" || true
exit 1
fi
echo "✓ ${SERVICE} is running (${STATUS})"
done
BACKEND_HOST_PORT=$(grep -E '^BACKEND_HOST_PORT=' .env 2>/dev/null | cut -d= -f2- | tr -d '"' || true)
BACKEND_HOST_PORT=${BACKEND_HOST_PORT:-8080}
# No actuator yet — treat any HTTP response as "server is up"
for i in 1 2 3 4 5 6 7 8; do
CODE=$(curl -s -o /dev/null -w "%{http_code}" "http://127.0.0.1:${BACKEND_HOST_PORT}/" || echo "000")
if [ "${CODE}" != "000" ]; then
echo "✓ Backend is responding on port ${BACKEND_HOST_PORT} (HTTP ${CODE})"
exit 0
fi
echo "Waiting for backend... attempt ${i}/8"
sleep 5
done
echo "ERROR: Backend is not responding on port ${BACKEND_HOST_PORT}"
docker compose -f docker-compose.yml logs --tail=50 backend || true
exit 1
.gitea/workflows/build.yml
+80
View File
@@ -0,0 +1,80 @@
name: Build Docker Image
on:
push:
branches:
- main
tags:
- "v*"
jobs:
build-backend:
runs-on: docker
steps:
- name: Checkout repository
uses: actions/checkout@v4
- name: Login to Docker registry
run: |
echo "${{ secrets.REGISTRY_PASSWORD }}" | \
docker login git.koppkb.com \
-u "${{ secrets.REGISTRY_USERNAME }}" \
--password-stdin
- name: Build & push backend image
run: |
set -e
IMAGE="git.koppkb.com/kopkb/qms-be"
TAGS="-t ${IMAGE}:${{ gitea.sha }}"
if [ "${{ gitea.ref_type }}" = "tag" ] && echo "${{ gitea.ref_name }}" | grep -q '^v'; then
TAGS="${TAGS} -t ${IMAGE}:${{ gitea.ref_name }}"
fi
echo "Building and pushing backend: ${TAGS}"
docker buildx build \
--platform linux/amd64 \
--cache-from type=registry,ref=${IMAGE}:buildcache,ignore-error=true \
--cache-to type=registry,ref=${IMAGE}:buildcache,mode=max \
-f be/Dockerfile \
${TAGS} \
--push \
be
# --- Frontend builds (enable when FE Dockerfiles are ready) ---
# build-frontend:
# runs-on: docker
#
# steps:
# - name: Checkout repository
# uses: actions/checkout@v4
#
# - name: Login to Docker registry
# run: |
# echo "${{ secrets.REGISTRY_PASSWORD }}" | \
# docker login git.koppkb.com \
# -u "${{ secrets.REGISTRY_USERNAME }}" \
# --password-stdin
#
# - name: Build & push frontend image
# run: |
# set -e
#
# IMAGE="git.koppkb.com/kopkb/qms-fe"
# TAGS="-t ${IMAGE}:${{ gitea.sha }}"
#
# if [ "${{ gitea.ref_type }}" = "tag" ] && echo "${{ gitea.ref_name }}" | grep -q '^v'; then
# TAGS="${TAGS} -t ${IMAGE}:${{ gitea.ref_name }}"
# fi
#
# echo "Building and pushing frontend: ${TAGS}"
# docker buildx build \
# --platform linux/amd64 \
# --cache-from type=registry,ref=${IMAGE}:buildcache,ignore-error=true \
# --cache-to type=registry,ref=${IMAGE}:buildcache,mode=max \
# -f fe/docker/Dockerfile \
# --build-arg VITE_API_BASE_URL=https://api.example.com \
# ${TAGS} \
# --push .
be/.dockerignore
+10
View File
@@ -0,0 +1,10 @@
target/
uploads/
.git/
.gitignore
.idea/
*.iml
.vscode/
*.md
.env
.DS_Store
be/.env.example
+12
View File
@@ -0,0 +1,12 @@
# Host ports (change these if they collide on your single server)
BACKEND_HOST_PORT=8080
MYSQL_HOST_PORT=3306
# MySQL
MYSQL_ROOT_PASSWORD=password
MYSQL_DATABASE=qms
# App
JWT_SECRET_KEY=change-me-to-a-long-random-secret
GOOGLE_CLIENT_ID=dummy-google-client-id
NOTIFICATIONS_MOCK=true
be/.env.production
+12
View File
@@ -0,0 +1,12 @@
# Host ports (change these if they collide on your single server)
BACKEND_HOST_PORT=8080
MYSQL_HOST_PORT=3306
# MySQL
MYSQL_ROOT_PASSWORD=R8qjjBJDg9NtL2IwcnoFMkn8pktwAZ;wsl
MYSQL_DATABASE=qms
# App
JWT_SECRET_KEY=a68uiaDQ0V3iLjF4DqMuS13GAVwkut55dlFbGCLyXTF
GOOGLE_CLIENT_ID=dummy-google-client-id
NOTIFICATIONS_MOCK=true
be/.gitignore
+3
View File
@@ -34,3 +34,6 @@ build/
### Uploads ###
uploads/
### Docker / env ###
.env
be/Dockerfile
+26 -3
View File
@@ -1,3 +1,26 @@
FROM openjdk:17-jdk-alpine
COPY target/bbqms-0.0.1-SNAPSHOT.jar ./app.jar
ENTRYPOINT ["java", "-jar", "/app.jar"]
# Build stage
FROM maven:3.9-eclipse-temurin-17-alpine AS build
WORKDIR /app
COPY pom.xml .
COPY mvnw .
COPY .mvn .mvn
COPY src ./src
RUN ./mvnw -q -DskipTests package
# Runtime stage
FROM eclipse-temurin:17-jre-alpine
WORKDIR /app
RUN addgroup -S qms && adduser -S qms -G qms \
&& mkdir -p /app/uploads/ads \
&& chown -R qms:qms /app
COPY --from=build /app/target/bbqms-0.0.1-SNAPSHOT.jar app.jar
USER qms
EXPOSE 8080
ENTRYPOINT ["java", "-jar", "app.jar"]
be/README.md
+35 -6
View File
@@ -1,9 +1,38 @@
## Build instructions
## Build instructions (local)
- Enter your database details in the **src/main/resources/application.yml** file
- Through IntelliJ simply click on the run button
- Or through console
- ./mvnw dependency:resolve
- ./mvnw spring-boot:run
- Enter your database details in the **src/main/resources/application.yml** file (or use env vars)
- Through IntelliJ simply click on the run button
- Or through console
- `./mvnw dependency:resolve`
- `./mvnw spring-boot:run`
##### **NOTE:** requires Java 17 and MySQL 8
## Docker deployment (single server)
From the `be/` directory:
```bash
cp .env.example .env
# Edit .env if ports 8080 / 3306 are already in use on the server
docker compose up -d --build
```
Services and default host ports:
| Service | Container | Host port (configurable) |
|----------|-----------|---------------------------|
| Backend | qms-backend | `BACKEND_HOST_PORT` → **8080** |
| MySQL | qms-mysql | `MYSQL_HOST_PORT` → **3306** |
API base URL on the server: `http://<server-ip>:8080`
Useful commands:
```bash
docker compose ps
docker compose logs -f backend
docker compose down # stop containers (keeps DB volume)
docker compose down -v # stop and delete DB/uploads volumes
```
be/docker-compose.yml
+43 -5
View File
@@ -2,18 +2,56 @@ services:
mysql:
image: mysql:8
container_name: qms-mysql
restart: unless-stopped
ports:
- "3306:3306"
# Host port can be changed via MYSQL_HOST_PORT in .env (default 3306)
- "${MYSQL_HOST_PORT:-3306}:3306"
environment:
MYSQL_ROOT_PASSWORD: password
MYSQL_DATABASE: qms
MYSQL_ROOT_PASSWORD: ${MYSQL_ROOT_PASSWORD:-password}
MYSQL_DATABASE: ${MYSQL_DATABASE:-qms}
volumes:
- qms-mysql-data:/var/lib/mysql
healthcheck:
test: ["CMD", "mysqladmin", "ping", "-h", "localhost", "-ppassword"]
test: ["CMD", "mysqladmin", "ping", "-h", "localhost", "-p${MYSQL_ROOT_PASSWORD:-password}"]
interval: 5s
timeout: 5s
retries: 10
retries: 20
start_period: 20s
networks:
- qms-net
backend:
image: ${BACKEND_IMAGE:-qms-backend}:${IMAGE_TAG:-local}
build:
context: .
dockerfile: Dockerfile
container_name: qms-backend
restart: unless-stopped
ports:
# Host port can be changed via BACKEND_HOST_PORT in .env (default 8080)
- "${BACKEND_HOST_PORT:-8080}:8080"
environment:
SERVER_PORT: 8080
# Use Docker service name "mysql", not localhost
SPRING_DATASOURCE_URL: jdbc:mysql://mysql:3306/${MYSQL_DATABASE:-qms}?allowPublicKeyRetrieval=true&useSSL=false
SPRING_DATASOURCE_USERNAME: root
SPRING_DATASOURCE_PASSWORD: ${MYSQL_ROOT_PASSWORD:-password}
JWT_SECRET_KEY: ${JWT_SECRET_KEY:-a68uiaDQ0V3iLjF4DqMuS13GAVwkut55dlFbGCLyXTF}
ADS_UPLOAD_DIR: /app/uploads/ads
NOTIFICATIONS_MOCK: ${NOTIFICATIONS_MOCK:-true}
GOOGLE_CLIENT_ID: ${GOOGLE_CLIENT_ID:-dummy-google-client-id}
volumes:
- qms-uploads:/app/uploads
depends_on:
mysql:
condition: service_healthy
networks:
- qms-net
volumes:
qms-mysql-data:
qms-uploads:
networks:
qms-net:
driver: bridge
be/src/main/resources/application.yml
+10 -7
View File
@@ -1,3 +1,6 @@
server:
port: ${SERVER_PORT:8080}
spring:
application:
name: qms
@@ -6,9 +9,9 @@ spring:
hibernate:
ddl-auto: none
datasource:
url: jdbc:mysql://localhost:3306/qms
username: root
password: password
url: ${SPRING_DATASOURCE_URL:jdbc:mysql://localhost:3306/qms}
username: ${SPRING_DATASOURCE_USERNAME}
password: ${SPRING_DATASOURCE_PASSWORD}
servlet:
multipart:
max-file-size: 100MB
@@ -18,14 +21,14 @@ spring:
client:
registration:
google:
client-id: dummy-google-client-id
client-id: ${GOOGLE_CLIENT_ID:dummy-google-client-id}
flyway:
schemas: qms
jwt:
header-title: Authorization
token-prefix: Bearer
secret-key: a68uiaDQ0V3iLjF4DqMuS13GAVwkut55dlFbGCLyXTF
secret-key: ${JWT_SECRET_KEY}
authorities-key: USER_AUTHORITIES
token-validity-time: PT30M
tfa:
@@ -35,6 +38,6 @@ tenancy:
default-code: DFLT
notifications:
expo-url: https://exp.host/--/api/v2/push/send
mock: true
mock: ${NOTIFICATIONS_MOCK:true}
ads:
upload-dir: uploads/ads
upload-dir: ${ADS_UPLOAD_DIR:uploads/ads}