mirror of
https://github.com/dat515-2025/Group-8.git
synced 2026-03-22 15:12:08 +01:00
Compare commits
16 Commits
fa1b9523a1
...
merge/data
| Author | SHA1 | Date | |
|---|---|---|---|
| bf213234b1 | |||
| 4ea6876b74 | |||
| 6d5dd1a222 | |||
|
|
f09f9eaa82 | ||
| ae10c4daff | |||
| abebdb019b | |||
| 6040f4339c | |||
| 72c241f4f7 | |||
| 8db669ac72 | |||
| e32e18f0de | |||
| 95996d22f8 | |||
|
|
991c070918 | ||
|
|
a717e4afeb | ||
|
|
2bc03bcd5b | ||
| dbd37a8b83 | |||
| f1cbdbce9c |
5
.github/workflows/frontend-pages.yml
vendored
5
.github/workflows/frontend-pages.yml
vendored
@@ -60,6 +60,7 @@ jobs:
|
||||
EVENT_NAME: ${{ github.event_name }}
|
||||
PR_NUMBER: ${{ github.event.pull_request.number || inputs.pr_number }}
|
||||
PR_TEMPLATE: ${{ vars.BACKEND_URL_PR_TEMPLATE }}
|
||||
DEV_BASE_DOMAIN: ${{ secrets.BASE_DOMAIN }}
|
||||
PROD_DOMAIN_VAR: ${{ vars.PROD_DOMAIN }}
|
||||
PROD_DOMAIN_SECRET: ${{ secrets.PROD_DOMAIN }}
|
||||
BACKEND_URL_OVERRIDE: ${{ vars.BACKEND_URL || secrets.BACKEND_URL }}
|
||||
@@ -75,10 +76,12 @@ jobs:
|
||||
URL="https://${BACKEND_URL_OVERRIDE}"
|
||||
fi
|
||||
else
|
||||
# 2) PR template when building for PR
|
||||
# 2) PR-specific URL when building for PR
|
||||
if [ "${MODE:-}" = "pr" ] || [ "${EVENT_NAME}" = "pull_request" ]; then
|
||||
if [ -n "${PR_TEMPLATE:-}" ] && [ -n "${PR_NUMBER:-}" ] ; then
|
||||
URL="${PR_TEMPLATE//\{PR\}/${PR_NUMBER}}"
|
||||
elif [ -n "${DEV_BASE_DOMAIN:-}" ] && [ -n "${PR_NUMBER:-}" ]; then
|
||||
URL="https://pr-${PR_NUMBER}.${DEV_BASE_DOMAIN}"
|
||||
fi
|
||||
fi
|
||||
# 3) Fallback to PROD_DOMAIN (prefer repo var, then secret)
|
||||
|
||||
@@ -45,11 +45,11 @@ flowchart LR
|
||||
proc_cron[Task planner] --> proc_queue
|
||||
proc_queue_worker --> ext_bank[(Bank API)]
|
||||
proc_queue_worker --> db
|
||||
client[Client/UI] --> api[API Gateway / Web Server]
|
||||
api --> svc[Web API]
|
||||
client[Client/UI] <--> api[API Gateway / Web Server]
|
||||
api <--> svc[Web API]
|
||||
svc --> proc_queue
|
||||
svc --> db[(Database)]
|
||||
svc --> cache[(Cache)]
|
||||
svc <--> db[(Database)]
|
||||
svc <--> cache[(Cache)]
|
||||
```
|
||||
|
||||
- Components and responsibilities: What does each box do?
|
||||
|
||||
@@ -11,7 +11,7 @@ script_location = %(here)s/alembic
|
||||
# Uncomment the line below if you want the files to be prepended with date and time
|
||||
# see https://alembic.sqlalchemy.org/en/latest/tutorial.html#editing-the-ini-file
|
||||
# for all available tokens
|
||||
# file_template = %%(year)d_%%(month).2d_%%(day).2d_%%(hour).2d%%(minute).2d-%%(rev)s_%%(slug)s
|
||||
file_template = %%(year)d_%%(month).2d_%%(day).2d_%%(hour).2d%%(minute).2d-%%(rev)s_%%(slug)s
|
||||
|
||||
# sys.path path, will be prepended to sys.path if present.
|
||||
# defaults to the current working directory. for multiple paths, the path separator
|
||||
|
||||
@@ -1,8 +1,8 @@
|
||||
"""Init migration
|
||||
"""add categories
|
||||
|
||||
Revision ID: 81f275275556
|
||||
Revision ID: 63e072f09836
|
||||
Revises:
|
||||
Create Date: 2025-09-24 17:39:25.346690
|
||||
Create Date: 2025-10-09 14:56:14.653249
|
||||
|
||||
"""
|
||||
from typing import Sequence, Union
|
||||
@@ -13,7 +13,7 @@ import sqlalchemy as sa
|
||||
|
||||
|
||||
# revision identifiers, used by Alembic.
|
||||
revision: str = '81f275275556'
|
||||
revision: str = '63e072f09836'
|
||||
down_revision: Union[str, Sequence[str], None] = None
|
||||
branch_labels: Union[str, Sequence[str], None] = None
|
||||
depends_on: Union[str, Sequence[str], None] = None
|
||||
@@ -22,12 +22,6 @@ depends_on: Union[str, Sequence[str], None] = None
|
||||
def upgrade() -> None:
|
||||
"""Upgrade schema."""
|
||||
# ### commands auto generated by Alembic - please adjust! ###
|
||||
op.create_table('transaction',
|
||||
sa.Column('id', sa.Integer(), autoincrement=True, nullable=False),
|
||||
sa.Column('amount', sa.Float(), nullable=False),
|
||||
sa.Column('description', sa.String(length=255), nullable=True),
|
||||
sa.PrimaryKeyConstraint('id')
|
||||
)
|
||||
op.create_table('user',
|
||||
sa.Column('first_name', sa.String(length=100), nullable=True),
|
||||
sa.Column('last_name', sa.String(length=100), nullable=True),
|
||||
@@ -40,13 +34,38 @@ def upgrade() -> None:
|
||||
sa.PrimaryKeyConstraint('id')
|
||||
)
|
||||
op.create_index(op.f('ix_user_email'), 'user', ['email'], unique=True)
|
||||
op.create_table('categories',
|
||||
sa.Column('id', sa.Integer(), autoincrement=True, nullable=False),
|
||||
sa.Column('name', sa.String(length=100), nullable=False),
|
||||
sa.Column('description', sa.String(length=255), nullable=True),
|
||||
sa.Column('user_id', fastapi_users_db_sqlalchemy.generics.GUID(), nullable=False),
|
||||
sa.ForeignKeyConstraint(['user_id'], ['user.id'], ),
|
||||
sa.PrimaryKeyConstraint('id'),
|
||||
sa.UniqueConstraint('name')
|
||||
)
|
||||
op.create_table('transaction',
|
||||
sa.Column('id', sa.Integer(), autoincrement=True, nullable=False),
|
||||
sa.Column('amount', sa.Float(), nullable=False),
|
||||
sa.Column('description', sa.String(length=255), nullable=True),
|
||||
sa.Column('user_id', fastapi_users_db_sqlalchemy.generics.GUID(), nullable=False),
|
||||
sa.ForeignKeyConstraint(['user_id'], ['user.id'], ),
|
||||
sa.PrimaryKeyConstraint('id')
|
||||
)
|
||||
op.create_table('category_transaction',
|
||||
sa.Column('id_category', sa.Integer(), nullable=True),
|
||||
sa.Column('id_transaction', sa.Integer(), nullable=True),
|
||||
sa.ForeignKeyConstraint(['id_category'], ['categories.id'], ),
|
||||
sa.ForeignKeyConstraint(['id_transaction'], ['transaction.id'], )
|
||||
)
|
||||
# ### end Alembic commands ###
|
||||
|
||||
|
||||
def downgrade() -> None:
|
||||
"""Downgrade schema."""
|
||||
# ### commands auto generated by Alembic - please adjust! ###
|
||||
op.drop_table('category_transaction')
|
||||
op.drop_table('transaction')
|
||||
op.drop_table('categories')
|
||||
op.drop_index(op.f('ix_user_email'), table_name='user')
|
||||
op.drop_table('user')
|
||||
op.drop_table('transaction')
|
||||
# ### end Alembic commands ###
|
||||
@@ -0,0 +1,34 @@
|
||||
"""update categories unique
|
||||
|
||||
Revision ID: 390041bd839e
|
||||
Revises: 63e072f09836
|
||||
Create Date: 2025-10-09 15:14:31.557686
|
||||
|
||||
"""
|
||||
from typing import Sequence, Union
|
||||
|
||||
from alembic import op
|
||||
import sqlalchemy as sa
|
||||
|
||||
|
||||
# revision identifiers, used by Alembic.
|
||||
revision: str = '390041bd839e'
|
||||
down_revision: Union[str, Sequence[str], None] = '63e072f09836'
|
||||
branch_labels: Union[str, Sequence[str], None] = None
|
||||
depends_on: Union[str, Sequence[str], None] = None
|
||||
|
||||
|
||||
def upgrade() -> None:
|
||||
"""Upgrade schema."""
|
||||
# ### commands auto generated by Alembic - please adjust! ###
|
||||
op.drop_index(op.f('name'), table_name='categories')
|
||||
op.create_unique_constraint('uix_name_user_id', 'categories', ['name', 'user_id'])
|
||||
# ### end Alembic commands ###
|
||||
|
||||
|
||||
def downgrade() -> None:
|
||||
"""Downgrade schema."""
|
||||
# ### commands auto generated by Alembic - please adjust! ###
|
||||
op.drop_constraint('uix_name_user_id', 'categories', type_='unique')
|
||||
op.create_index(op.f('name'), 'categories', ['name'], unique=True)
|
||||
# ### end Alembic commands ###
|
||||
@@ -17,6 +17,7 @@ if not DATABASE_URL:
|
||||
# Load all models to register them
|
||||
from app.models.user import User
|
||||
from app.models.transaction import Transaction
|
||||
from app.models.categories import Category
|
||||
|
||||
ssl_enabled = os.getenv("MARIADB_HOST", "localhost") != "localhost"
|
||||
connect_args = {"ssl": {"ssl": True}} if ssl_enabled else {}
|
||||
|
||||
25
7project/backend/app/models/categories.py
Normal file
25
7project/backend/app/models/categories.py
Normal file
@@ -0,0 +1,25 @@
|
||||
from fastapi_users_db_sqlalchemy import GUID
|
||||
from sqlalchemy import Column, Integer, String, ForeignKey, Table, UniqueConstraint
|
||||
from sqlalchemy.orm import relationship
|
||||
|
||||
from app.core.base import Base
|
||||
|
||||
association_table = Table(
|
||||
"category_transaction",
|
||||
Base.metadata,
|
||||
Column("id_category", Integer, ForeignKey("categories.id")),
|
||||
Column("id_transaction", Integer, ForeignKey("transaction.id"))
|
||||
)
|
||||
|
||||
|
||||
class Category(Base):
|
||||
__tablename__ = "categories"
|
||||
__table_args__ = (
|
||||
UniqueConstraint("name", "user_id", name="uix_name_user_id"),
|
||||
)
|
||||
id = Column(Integer, primary_key=True, autoincrement=True)
|
||||
name = Column(String(length=100), nullable=False)
|
||||
description = Column(String(length=255), nullable=True)
|
||||
user_id = Column(GUID, ForeignKey("user.id"), nullable=False)
|
||||
user = relationship("User", back_populates="categories")
|
||||
transactions = relationship("Transaction", secondary=association_table, back_populates="categories")
|
||||
@@ -1,9 +1,17 @@
|
||||
from sqlalchemy import Column, Integer, String, Float
|
||||
from fastapi_users_db_sqlalchemy import GUID
|
||||
from sqlalchemy import Column, Integer, String, Float, ForeignKey
|
||||
from sqlalchemy.orm import relationship
|
||||
from app.core.base import Base
|
||||
from app.models.categories import association_table
|
||||
|
||||
|
||||
class Transaction(Base):
|
||||
__tablename__ = "transaction"
|
||||
id = Column(Integer, primary_key=True, autoincrement=True)
|
||||
amount = Column(Float, nullable=False)
|
||||
description = Column(String(length=255), nullable=True)
|
||||
user_id = Column(GUID, ForeignKey("user.id"), nullable=False)
|
||||
|
||||
# Relationship
|
||||
user = relationship("User", back_populates="transactions")
|
||||
categories = relationship("Category", secondary=association_table, back_populates="transactions")
|
||||
|
||||
@@ -1,7 +1,13 @@
|
||||
from sqlalchemy import Column, String
|
||||
from sqlalchemy.orm import relationship
|
||||
from fastapi_users.db import SQLAlchemyBaseUserTableUUID
|
||||
from app.core.base import Base
|
||||
|
||||
|
||||
class User(SQLAlchemyBaseUserTableUUID, Base):
|
||||
first_name = Column(String(length=100), nullable=True)
|
||||
last_name = Column(String(length=100), nullable=True)
|
||||
|
||||
# Relationship
|
||||
transactions = relationship("Transaction", back_populates="user")
|
||||
categories = relationship("Category", back_populates="user")
|
||||
@@ -25,7 +25,7 @@ spec:
|
||||
- containerPort: {{ .Values.app.port }}
|
||||
env:
|
||||
- name: MARIADB_HOST
|
||||
value: {{ printf "%s.%s.svc.cluster.local" .Values.mariadb.mariaDbRef.name .Values.mariadb.mariaDbRef.namespace | quote }}
|
||||
value: "mariadb-repl-maxscale-internal.mariadb-operator.svc.cluster.local"
|
||||
- name: MARIADB_PORT
|
||||
value: '3306'
|
||||
- name: MARIADB_DB
|
||||
|
||||
@@ -29,6 +29,7 @@ worker:
|
||||
# Queue name for Celery worker and for CRD Queue
|
||||
mailQueueName: "mail_queue"
|
||||
|
||||
|
||||
service:
|
||||
port: 80
|
||||
|
||||
|
||||
81
7project/checklist.md
Normal file
81
7project/checklist.md
Normal file
@@ -0,0 +1,81 @@
|
||||
# Project Evaluation Checklist
|
||||
|
||||
The group earn points by completing items from the categories below.
|
||||
You are not expected to complete all items.
|
||||
Focus on areas that align with your project goals and interests.
|
||||
|
||||
The core deliverables are required.
|
||||
This means that you must get at least 2 points for each item in this category.
|
||||
|
||||
| **Category** | **Item** | **Max Points** | **Points** |
|
||||
| -------------------------------- | --------------------------------------- | -------------- | ---------------- |
|
||||
| **Core Deliverables (Required)** | | | |
|
||||
| Codebase & Organization | Well-organized project structure | 5 | |
|
||||
| | Clean, readable code | 5 | |
|
||||
| | Use planning tool (e.g., GitHub issues) | 5 | |
|
||||
| | Proper version control usage | 5 | |
|
||||
| | Complete source code | 5 | |
|
||||
| Documentation | Comprehensive reproducibility report | 10 | |
|
||||
| | Updated design document | 5 | |
|
||||
| | Clear build/deployment instructions | 5 | |
|
||||
| | Troubleshooting guide | 5 | |
|
||||
| | Completed self-assessment table | 5 | |
|
||||
| | Hour sheets for all members | 5 | |
|
||||
| Presentation Video | Project demonstration | 5 | |
|
||||
| | Code walk-through | 5 | |
|
||||
| | Deployment showcase | 5 | |
|
||||
| **Technical Implementation** | | | |
|
||||
| Application Functionality | Basic functionality works | 10 | |
|
||||
| | Advanced features implemented | 10 | |
|
||||
| | Error handling & robustness | 10 | |
|
||||
| | User-friendly interface | 5 | |
|
||||
| Backend & Architecture | Stateless web server | 5 | |
|
||||
| | Stateful application | 10 | |
|
||||
| | Database integration | 10 | |
|
||||
| | API design | 5 | |
|
||||
| | Microservices architecture | 10 | |
|
||||
| Cloud Integration | Basic cloud deployment | 10 | |
|
||||
| | Cloud APIs usage | 10 | |
|
||||
| | Serverless components | 10 | |
|
||||
| | Advanced cloud services | 5 | |
|
||||
| **DevOps & Deployment** | | | |
|
||||
| Containerization | Basic Dockerfile | 5 | |
|
||||
| | Optimized Dockerfile | 5 | |
|
||||
| | Docker Compose | 5 | |
|
||||
| | Persistent storage | 5 | |
|
||||
| Deployment & Scaling | Manual deployment | 5 | |
|
||||
| | Automated deployment | 5 | |
|
||||
| | Multiple replicas | 5 | |
|
||||
| | Kubernetes deployment | 10 | |
|
||||
| **Quality Assurance** | | | |
|
||||
| Testing | Unit tests | 5 | |
|
||||
| | Integration tests | 5 | |
|
||||
| | End-to-end tests | 5 | |
|
||||
| | Performance testing | 5 | |
|
||||
| Monitoring & Operations | Health checks | 5 | |
|
||||
| | Logging | 5 | |
|
||||
| | Metrics/Monitoring | 5 | |
|
||||
| Security | HTTPS/TLS | 5 | |
|
||||
| | Authentication | 5 | |
|
||||
| | Authorization | 5 | |
|
||||
| **Innovation & Excellence** | | | |
|
||||
| Advanced Features and | AI/ML Integration | 10 | |
|
||||
| Technical Excellence | Real-time features | 10 | |
|
||||
| | Creative problem solving | 10 | |
|
||||
| | Performance optimization | 5 | |
|
||||
| | Exceptional user experience | 5 | |
|
||||
| **Total** | | **255** | **[Your Total]** |
|
||||
|
||||
## Grading Scale
|
||||
|
||||
- **Minimum Required: 100 points**
|
||||
- **Maximum: 200+ points**
|
||||
|
||||
| Grade | Points |
|
||||
| ----- | -------- |
|
||||
| A | 180-200+ |
|
||||
| B | 160-179 |
|
||||
| C | 140-159 |
|
||||
| D | 120-139 |
|
||||
| E | 100-119 |
|
||||
| F | 0-99 |
|
||||
@@ -8,4 +8,8 @@ fi
|
||||
cd backend || { echo "Directory 'backend' does not exist"; exit 1; }
|
||||
alembic revision --autogenerate -m "$1"
|
||||
git add alembic/versions/*
|
||||
YELLOW='\033[1;33m'
|
||||
NC='\033[0m' # No Color
|
||||
|
||||
echo -e "${YELLOW}Don't forget to check imports in the new migration file!${NC}"
|
||||
cd - || exit
|
||||
54
7project/meetings/meeting-9-10.md
Normal file
54
7project/meetings/meeting-9-10.md
Normal file
@@ -0,0 +1,54 @@
|
||||
# Weekly Meeting Notes
|
||||
|
||||
- Group 8 - Personal finance tracker
|
||||
- Mentor: Jaychander
|
||||
|
||||
Keep all meeting notes in the `meetings.md` file in your project folder.
|
||||
Just copy the template below for each weekly meeting and fill in the details.
|
||||
|
||||
## Administrative Info
|
||||
|
||||
- Date: 2025-10-08
|
||||
- Attendees: Dejan Ribarovski, Lukas Trkan
|
||||
- Notetaker: Dejan Ribarovski
|
||||
|
||||
## Progress Update (Before Meeting)
|
||||
|
||||
Summary of what has been accomplished since the last meeting in the following categories.
|
||||
|
||||
### Coding
|
||||
|
||||
Lukas has implemented the template source directories, source files and config files necessary for deployment
|
||||
- docker compose for database, redis cache and rabbit MQ
|
||||
- tofu
|
||||
- backend template
|
||||
- frontend template
|
||||
- charts templates
|
||||
|
||||
### Documentation
|
||||
- Created GitHub issues for the next steps
|
||||
- Added this document + checklist and report
|
||||
|
||||
## Questions and Topics for Discussion (Before Meeting)
|
||||
|
||||
Prepare 3-5 questions and topics you want to discuss with your mentor.
|
||||
|
||||
1. Anything we should add structure-wise?
|
||||
2. Anything you would like us to prioritize until next week?
|
||||
|
||||
## Discussion Notes (During Meeting)
|
||||
|
||||
- start working on the report
|
||||
- start coding the actual code
|
||||
- write problems solved
|
||||
- redo the system diagram - see the response as well
|
||||
- create a meetings folder wih seperate meetings files
|
||||
## Action Items for Next Week (During Meeting)
|
||||
|
||||
Last 3 minutes of the meeting, summarize action items.
|
||||
|
||||
- [ ] start coding the app logic
|
||||
- [ ] start writing the report so it matches the actual progress
|
||||
- [ ] redo the system diagram so it includes a response flow
|
||||
|
||||
---
|
||||
41
7project/meetings/meeting-template.md
Normal file
41
7project/meetings/meeting-template.md
Normal file
@@ -0,0 +1,41 @@
|
||||
# Weekly Meeting Notes
|
||||
|
||||
- Group X - Project Title
|
||||
- Mentor: Mentor Name
|
||||
|
||||
Keep all meeting notes in the `meetings.md` file in your project folder.
|
||||
Just copy the template below for each weekly meeting and fill in the details.
|
||||
|
||||
## Administrative Info
|
||||
|
||||
- Date: 2025-09-19
|
||||
- Attendees: Name1, Name2, Name3
|
||||
- Notetaker: Name1
|
||||
|
||||
## Progress Update (Before Meeting)
|
||||
|
||||
Summary of what has been accomplished since the last meeting in the following categories.
|
||||
|
||||
### Coding
|
||||
|
||||
### Documentation
|
||||
|
||||
## Questions and Topics for Discussion (Before Meeting)
|
||||
|
||||
Prepare 3-5 questions and topics you want to discuss with your mentor.
|
||||
|
||||
1. Question 1
|
||||
2. Question 2
|
||||
3. Question 3
|
||||
|
||||
## Discussion Notes (During Meeting)
|
||||
|
||||
## Action Items for Next Week (During Meeting)
|
||||
|
||||
Last 3 minutes of the meeting, summarize action items.
|
||||
|
||||
- [ ] Action Item 1
|
||||
- [ ] Action Item 2
|
||||
- [ ] Action Item 3
|
||||
|
||||
---
|
||||
302
7project/report.md
Normal file
302
7project/report.md
Normal file
@@ -0,0 +1,302 @@
|
||||
# Project Report
|
||||
|
||||
> **Instructions**:
|
||||
> This template provides the structure for your project report.
|
||||
> Replace the placeholder text with your actual content.
|
||||
> Remove instructions that are not relevant for your project, but leave the headings along with a (NA) label.
|
||||
|
||||
## Project Overview
|
||||
|
||||
**Project Name**: [Your project name]
|
||||
|
||||
**Group Members**:
|
||||
|
||||
- Student number, Name, GitHub username
|
||||
- Student number, Name, GitHub username
|
||||
- Student number, Name, GitHub username
|
||||
|
||||
**Brief Description**:
|
||||
[2-3 sentences describing what your application does and its main purpose]
|
||||
|
||||
## Architecture Overview
|
||||
|
||||
### High-Level Architecture
|
||||
|
||||
[Describe the overall system architecture. Consider including a diagram using mermaid or linking to an image]
|
||||
|
||||
```mermaid
|
||||
graph TD
|
||||
A[Component A] --> B[Component B]
|
||||
B --> C[Component C]
|
||||
```
|
||||
|
||||
### Components
|
||||
|
||||
- **Component 1**: [Description of what this component does]
|
||||
- **Component 2**: [Description of what this component does]
|
||||
- **Component 3**: [Description of what this component does]
|
||||
|
||||
### Technologies Used
|
||||
|
||||
- **Backend**: [e.g., Go, Node.js, Python]
|
||||
- **Database**: [e.g., PostgreSQL, MongoDB, Redis]
|
||||
- **Cloud Services**: [e.g., AWS EC2, Google Cloud Run, Azure Functions]
|
||||
- **Container Orchestration**: [e.g., Docker, Kubernetes]
|
||||
- **Other**: [List other significant technologies]
|
||||
|
||||
## Prerequisites
|
||||
|
||||
### System Requirements
|
||||
|
||||
- Operating System: [e.g., Linux, macOS, Windows]
|
||||
- Minimum RAM: [e.g., 8GB]
|
||||
- Storage: [e.g., 10GB free space]
|
||||
|
||||
### Required Software
|
||||
|
||||
- [Software 1] (version X.X or higher)
|
||||
- [Software 2] (version X.X or higher)
|
||||
- [etc.]
|
||||
|
||||
### Dependencies
|
||||
|
||||
```bash
|
||||
# List key dependencies that need to be installed
|
||||
# For example:
|
||||
# Docker Engine 20.10+
|
||||
# Node.js 18+
|
||||
# Go 1.25+
|
||||
```
|
||||
|
||||
## Build Instructions
|
||||
|
||||
### 1. Clone the Repository
|
||||
|
||||
```bash
|
||||
git clone [your-repository-url]
|
||||
cd [repository-name]
|
||||
```
|
||||
|
||||
### 2. Install Dependencies
|
||||
|
||||
```bash
|
||||
# Provide step-by-step commands
|
||||
# For example:
|
||||
# npm install
|
||||
# go mod download
|
||||
```
|
||||
|
||||
### 3. Build the Application
|
||||
|
||||
```bash
|
||||
# Provide exact build commands
|
||||
# For example:
|
||||
# make build
|
||||
# docker build -t myapp .
|
||||
```
|
||||
|
||||
### 4. Configuration
|
||||
|
||||
```bash
|
||||
# Any configuration steps needed
|
||||
# Environment variables to set
|
||||
# Configuration files to create
|
||||
```
|
||||
|
||||
## Deployment Instructions
|
||||
|
||||
### Local Deployment
|
||||
|
||||
```bash
|
||||
# Step-by-step commands for local deployment
|
||||
# For example:
|
||||
# docker-compose up -d
|
||||
# kubectl apply -f manifests/
|
||||
```
|
||||
|
||||
### Cloud Deployment
|
||||
|
||||
```bash
|
||||
# Commands for cloud deployment
|
||||
# Include any cloud-specific setup
|
||||
```
|
||||
|
||||
### Verification
|
||||
|
||||
```bash
|
||||
# Commands to verify deployment worked
|
||||
# How to check if services are running
|
||||
# Example health check endpoints
|
||||
```
|
||||
|
||||
## Testing Instructions
|
||||
|
||||
### Unit Tests
|
||||
|
||||
```bash
|
||||
# Commands to run unit tests
|
||||
# For example:
|
||||
# go test ./...
|
||||
# npm test
|
||||
```
|
||||
|
||||
### Integration Tests
|
||||
|
||||
```bash
|
||||
# Commands to run integration tests
|
||||
# Any setup required for integration tests
|
||||
```
|
||||
|
||||
### End-to-End Tests
|
||||
|
||||
```bash
|
||||
# Commands to run e2e tests
|
||||
# How to set up test environment
|
||||
```
|
||||
|
||||
## Usage Examples
|
||||
|
||||
### Basic Usage
|
||||
|
||||
```bash
|
||||
# Examples of how to use the application
|
||||
# Common commands or API calls
|
||||
# Sample data or test scenarios
|
||||
```
|
||||
|
||||
### Advanced Features
|
||||
|
||||
```bash
|
||||
# Examples showcasing advanced functionality
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
## Presentation Video
|
||||
|
||||
**YouTube Link**: [Insert your YouTube link here]
|
||||
|
||||
**Duration**: [X minutes Y seconds]
|
||||
|
||||
**Video Includes**:
|
||||
|
||||
- [ ] Project overview and architecture
|
||||
- [ ] Live demonstration of key features
|
||||
- [ ] Code walkthrough
|
||||
- [ ] Build and deployment showcase
|
||||
|
||||
## Troubleshooting
|
||||
|
||||
### Common Issues
|
||||
|
||||
#### Issue 1: [Common problem]
|
||||
|
||||
**Symptoms**: [What the user sees]
|
||||
**Solution**: [Step-by-step fix]
|
||||
|
||||
#### Issue 2: [Another common problem]
|
||||
|
||||
**Symptoms**: [What the user sees]
|
||||
**Solution**: [Step-by-step fix]
|
||||
|
||||
### Debug Commands
|
||||
|
||||
```bash
|
||||
# Useful commands for debugging
|
||||
# Log viewing commands
|
||||
# Service status checks
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
## Self-Assessment Table
|
||||
|
||||
> Be honest and detailed in your assessments.
|
||||
> This information is used for individual grading.
|
||||
> Link to the specific commit on GitHub for each contribution.
|
||||
|
||||
| Task/Component | Assigned To | Status | Time Spent | Difficulty | Notes |
|
||||
| ------------------------------------------------------------------- | ----------- | ------------- | ---------- | ---------- | ----------- |
|
||||
| Project Setup & Repository | [Name] | ✅ Complete | [X hours] | Medium | [Any notes] |
|
||||
| [Design Document](https://github.com/dat515-2025/group-name) | [Name] | ✅ Complete | [X hours] | Easy | [Any notes] |
|
||||
| [Backend API Development](https://github.com/dat515-2025/group-name) | [Name] | ✅ Complete | [X hours] | Hard | [Any notes] |
|
||||
| [Database Setup & Models](https://github.com/dat515-2025/group-name) | [Name] | ✅ Complete | [X hours] | Medium | [Any notes] |
|
||||
| [Frontend Development](https://github.com/dat515-2025/group-name) | [Name] | 🔄 In Progress | [X hours] | Medium | [Any notes] |
|
||||
| [Docker Configuration](https://github.com/dat515-2025/group-name) | [Name] | ✅ Complete | [X hours] | Easy | [Any notes] |
|
||||
| [Cloud Deployment](https://github.com/dat515-2025/group-name) | [Name] | ✅ Complete | [X hours] | Hard | [Any notes] |
|
||||
| [Testing Implementation](https://github.com/dat515-2025/group-name) | [Name] | ⏳ Pending | [X hours] | Medium | [Any notes] |
|
||||
| [Documentation](https://github.com/dat515-2025/group-name) | [Name] | ✅ Complete | [X hours] | Easy | [Any notes] |
|
||||
| [Presentation Video](https://github.com/dat515-2025/group-name) | [Name] | ✅ Complete | [X hours] | Medium | [Any notes] |
|
||||
|
||||
**Legend**: ✅ Complete | 🔄 In Progress | ⏳ Pending | ❌ Not Started
|
||||
|
||||
## Hour Sheet
|
||||
|
||||
> Link to the specific commit on GitHub for each contribution.
|
||||
|
||||
### [Team Member 1 Name]
|
||||
|
||||
| Date | Activity | Hours | Description |
|
||||
| --------- | ------------------- | ---------- | ----------------------------------- |
|
||||
| [Date] | Initial Setup | [X.X] | Repository setup, project structure |
|
||||
| [Date] | Backend Development | [X.X] | Implemented user authentication |
|
||||
| [Date] | Testing | [X.X] | Unit tests for API endpoints |
|
||||
| [Date] | Documentation | [X.X] | Updated README and design doc |
|
||||
| **Total** | | **[XX.X]** | |
|
||||
|
||||
### [Team Member 2 Name]
|
||||
|
||||
| Date | Activity | Hours | Description |
|
||||
| --------- | -------------------- | ---------- | ----------------------------------------- |
|
||||
| [Date] | Frontend Development | [X.X] | Created user interface mockups |
|
||||
| [Date] | Integration | [X.X] | Connected frontend to backend API |
|
||||
| [Date] | Deployment | [X.X] | Docker configuration and cloud deployment |
|
||||
| [Date] | Testing | [X.X] | End-to-end testing |
|
||||
| **Total** | | **[XX.X]** | |
|
||||
|
||||
### [Team Member 3 Name] (if applicable)
|
||||
|
||||
| Date | Activity | Hours | Description |
|
||||
| --------- | ------------------------ | ---------- | -------------------------------- |
|
||||
| [Date] | Database Design | [X.X] | Schema design and implementation |
|
||||
| [Date] | Cloud Configuration | [X.X] | AWS/GCP setup and configuration |
|
||||
| [Date] | Performance Optimization | [X.X] | Caching and query optimization |
|
||||
| [Date] | Monitoring | [X.X] | Logging and monitoring setup |
|
||||
| **Total** | | **[XX.X]** | |
|
||||
|
||||
### Group Total: [XXX.X] hours
|
||||
|
||||
---
|
||||
|
||||
## Final Reflection
|
||||
|
||||
### What We Learned
|
||||
|
||||
[Reflect on the key technical and collaboration skills learned during this project]
|
||||
|
||||
### Challenges Faced
|
||||
|
||||
[Describe the main challenges and how you overcame them]
|
||||
|
||||
### If We Did This Again
|
||||
|
||||
[What would you do differently? What worked well that you'd keep?]
|
||||
|
||||
### Individual Growth
|
||||
|
||||
#### [Team Member 1 Name]
|
||||
|
||||
[Personal reflection on growth, challenges, and learning]
|
||||
|
||||
#### [Team Member 2 Name]
|
||||
|
||||
[Personal reflection on growth, challenges, and learning]
|
||||
|
||||
#### [Team Member 3 Name] (if applicable)
|
||||
|
||||
[Personal reflection on growth, challenges, and learning]
|
||||
|
||||
---
|
||||
|
||||
**Report Completion Date**: [Date]
|
||||
**Last Updated**: [Date]
|
||||
@@ -96,6 +96,13 @@ module "database" {
|
||||
|
||||
phpmyadmin_enabled = var.phpmyadmin_enabled
|
||||
cloudflare_domain = var.cloudflare_domain
|
||||
|
||||
s3_enabled = var.s3_enabled
|
||||
s3_bucket = var.s3_bucket
|
||||
s3_region = var.s3_region
|
||||
s3_endpoint = var.s3_endpoint
|
||||
s3_key_id = var.s3_key_id
|
||||
s3_key_secret = var.s3_key_secret
|
||||
}
|
||||
|
||||
#module "argocd" {
|
||||
|
||||
@@ -1,4 +1,4 @@
|
||||
apiVersion: v2
|
||||
name: maxscale-helm
|
||||
version: 1.0.7
|
||||
version: 1.0.14
|
||||
description: Helm chart for MaxScale related Kubernetes manifests
|
||||
|
||||
@@ -0,0 +1,42 @@
|
||||
{{- if .Values.s3.enabled }}
|
||||
apiVersion: k8s.mariadb.com/v1alpha1
|
||||
kind: Backup
|
||||
metadata:
|
||||
name: backup
|
||||
namespace: mariadb-operator
|
||||
spec:
|
||||
mariaDbRef:
|
||||
name: mariadb-repl
|
||||
namespace: mariadb-operator
|
||||
schedule:
|
||||
cron: "0 */3 * * *"
|
||||
suspend: false
|
||||
timeZone: "Europe/Prague"
|
||||
maxRetention: 720h # 30 days
|
||||
compression: bzip2
|
||||
storage:
|
||||
s3:
|
||||
bucket: {{ .Values.s3.bucket | quote }}
|
||||
endpoint: {{ .Values.s3.endpoint | quote }}
|
||||
accessKeyIdSecretKeyRef:
|
||||
name: s3-credentials
|
||||
key: key_id
|
||||
secretAccessKeySecretKeyRef:
|
||||
name: s3-credentials
|
||||
key: secret_key
|
||||
region: {{ .Values.s3.region | quote }}
|
||||
tls:
|
||||
enabled: true
|
||||
# Define a PVC to use as staging area for keeping the backups while they are being processed.
|
||||
stagingStorage:
|
||||
persistentVolumeClaim:
|
||||
resources:
|
||||
requests:
|
||||
storage: 10Gi
|
||||
accessModes:
|
||||
- ReadWriteOnce
|
||||
args:
|
||||
- --single-transaction
|
||||
- --all-databases
|
||||
logLevel: info
|
||||
{{- end }}
|
||||
@@ -60,6 +60,8 @@ spec:
|
||||
scrapeTimeout: 10s
|
||||
prometheusRelease: kube-prometheus-stack
|
||||
jobLabel: mariadb-monitoring
|
||||
auth:
|
||||
generate: true
|
||||
|
||||
tls:
|
||||
enabled: true
|
||||
|
||||
@@ -0,0 +1,11 @@
|
||||
{{- if .Values.s3.enabled }}
|
||||
apiVersion: v1
|
||||
kind: Secret
|
||||
metadata:
|
||||
name: s3-credentials
|
||||
namespace: mariadb-operator
|
||||
type: Opaque
|
||||
stringData:
|
||||
key_id: "{{ .Values.s3.key_id }}"
|
||||
secret_key: "{{ .Values.s3.key_secret }}"
|
||||
{{- end }}
|
||||
@@ -28,7 +28,7 @@ spec:
|
||||
- name: DATABASE_ENABLE_SSL
|
||||
value: "yes"
|
||||
- name: DATABASE_HOST
|
||||
value: "mariadb-repl"
|
||||
value: "mariadb-repl-maxscale-internal"
|
||||
- name: DATABASE_PORT_NUMBER
|
||||
value: "3306"
|
||||
- name: PHPMYADMIN_ALLOW_NO_PASSWORD
|
||||
|
||||
@@ -14,4 +14,12 @@ metallb:
|
||||
phpmyadmin:
|
||||
enabled: true
|
||||
|
||||
s3:
|
||||
enabled: false
|
||||
endpoint: ""
|
||||
region: ""
|
||||
bucket: ""
|
||||
key_id: ""
|
||||
key_secret: ""
|
||||
|
||||
base_domain: example.com
|
||||
|
||||
@@ -9,16 +9,16 @@ terraform {
|
||||
version = "3.0.2"
|
||||
}
|
||||
kubernetes = {
|
||||
source = "hashicorp/kubernetes"
|
||||
source = "hashicorp/kubernetes"
|
||||
version = "2.38.0"
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
resource "kubernetes_namespace" "mariadb-operator" {
|
||||
metadata {
|
||||
name = "mariadb-operator"
|
||||
}
|
||||
metadata {
|
||||
name = "mariadb-operator"
|
||||
}
|
||||
}
|
||||
|
||||
locals {
|
||||
@@ -30,46 +30,53 @@ locals {
|
||||
}
|
||||
|
||||
resource "kubectl_manifest" "secrets" {
|
||||
yaml_body = local.mariadb_secret_yaml
|
||||
depends_on = [ kubernetes_namespace.mariadb-operator ]
|
||||
yaml_body = local.mariadb_secret_yaml
|
||||
depends_on = [kubernetes_namespace.mariadb-operator]
|
||||
}
|
||||
|
||||
|
||||
resource "helm_release" "mariadb-operator-crds" {
|
||||
name = "mariadb-operator-crds"
|
||||
repository = "https://helm.mariadb.com/mariadb-operator"
|
||||
chart = "mariadb-operator-crds"
|
||||
namespace = "mariadb-operator"
|
||||
version = "25.8.4"
|
||||
depends_on = [ kubectl_manifest.secrets ]
|
||||
timeout = 3600
|
||||
name = "mariadb-operator-crds"
|
||||
repository = "https://helm.mariadb.com/mariadb-operator"
|
||||
chart = "mariadb-operator-crds"
|
||||
namespace = "mariadb-operator"
|
||||
version = "25.8.4"
|
||||
depends_on = [kubectl_manifest.secrets]
|
||||
timeout = 3600
|
||||
}
|
||||
|
||||
|
||||
resource "helm_release" "mariadb-operator" {
|
||||
name = "mariadb-operator"
|
||||
repository = "https://helm.mariadb.com/mariadb-operator"
|
||||
chart = "mariadb-operator"
|
||||
depends_on = [ helm_release.mariadb-operator-crds, kubectl_manifest.secrets ]
|
||||
namespace = "mariadb-operator"
|
||||
timeout = 3600
|
||||
name = "mariadb-operator"
|
||||
repository = "https://helm.mariadb.com/mariadb-operator"
|
||||
chart = "mariadb-operator"
|
||||
depends_on = [helm_release.mariadb-operator-crds, kubectl_manifest.secrets]
|
||||
namespace = "mariadb-operator"
|
||||
version = "25.8.3"
|
||||
timeout = 3600
|
||||
}
|
||||
|
||||
resource "helm_release" "maxscale_helm" {
|
||||
name = "maxscale-helm"
|
||||
chart = "${path.module}/charts/maxscale-helm"
|
||||
version = "1.0.7"
|
||||
depends_on = [ helm_release.mariadb-operator-crds, kubectl_manifest.secrets ]
|
||||
version = "1.0.14"
|
||||
depends_on = [helm_release.mariadb-operator-crds, kubectl_manifest.secrets]
|
||||
timeout = 3600
|
||||
|
||||
set = [
|
||||
{ name = "user.name", value = var.mariadb_user_name },
|
||||
{ name = "user.host", value = var.mariadb_user_host },
|
||||
{ name = "metallb.maxscale_ip", value = var.maxscale_ip },
|
||||
{ name = "metallb.service_ip", value = var.service_ip },
|
||||
{ name = "metallb.primary_ip", value = var.primary_ip },
|
||||
{ name = "metallb.secondary_ip", value = var.secondary_ip },
|
||||
{ name = "phpmyadmin.enabled", value = tostring(var.phpmyadmin_enabled) },
|
||||
{ name = "base_domain", value = var.cloudflare_domain }
|
||||
{ name = "user.name", value = var.mariadb_user_name },
|
||||
{ name = "user.host", value = var.mariadb_user_host },
|
||||
{ name = "metallb.maxscale_ip", value = var.maxscale_ip },
|
||||
{ name = "metallb.service_ip", value = var.service_ip },
|
||||
{ name = "metallb.primary_ip", value = var.primary_ip },
|
||||
{ name = "metallb.secondary_ip", value = var.secondary_ip },
|
||||
{ name = "phpmyadmin.enabled", value = tostring(var.phpmyadmin_enabled) },
|
||||
{ name = "base_domain", value = var.cloudflare_domain },
|
||||
{ name = "s3.key_id", value = var.s3_key_id },
|
||||
{ name = "s3.key_secret", value = var.s3_key_secret },
|
||||
{ name = "s3.enabled", value = var.s3_enabled },
|
||||
{ name = "s3.endpoint", value = var.s3_endpoint },
|
||||
{ name = "s3.region", value = var.s3_region },
|
||||
{ name = "s3.bucket", value = var.s3_bucket },
|
||||
]
|
||||
}
|
||||
|
||||
@@ -52,7 +52,39 @@ variable "mariadb_user_password" {
|
||||
}
|
||||
|
||||
variable "cloudflare_domain" {
|
||||
type = string
|
||||
default = "Base cloudflare domain, e.g. example.com"
|
||||
type = string
|
||||
default = "Base cloudflare domain, e.g. example.com"
|
||||
nullable = false
|
||||
}
|
||||
|
||||
variable "s3_key_id" {
|
||||
description = "S3 Key ID for backups"
|
||||
type = string
|
||||
sensitive = true
|
||||
}
|
||||
|
||||
variable "s3_key_secret" {
|
||||
description = "S3 Key Secret for backups"
|
||||
type = string
|
||||
sensitive = true
|
||||
}
|
||||
|
||||
variable "s3_enabled" {
|
||||
description = "Enable S3 backups"
|
||||
type = bool
|
||||
}
|
||||
|
||||
variable "s3_endpoint" {
|
||||
description = "S3 endpoint for backups"
|
||||
type = string
|
||||
}
|
||||
|
||||
variable "s3_region" {
|
||||
description = "S3 region for backups"
|
||||
type = string
|
||||
}
|
||||
|
||||
variable "s3_bucket" {
|
||||
description = "S3 bucket name for backups"
|
||||
type = string
|
||||
}
|
||||
|
||||
15
7project/tofu/modules/metrics-server/values.yaml
Normal file
15
7project/tofu/modules/metrics-server/values.yaml
Normal file
@@ -0,0 +1,15 @@
|
||||
# Values overriding defaults for metrics-server Helm chart
|
||||
# Fix TLS and address selection issues when scraping kubelets (common on Talos)
|
||||
args:
|
||||
- --kubelet-insecure-tls
|
||||
- --kubelet-preferred-address-types=InternalIP,Hostname,InternalDNS,ExternalDNS,ExternalIP
|
||||
- --kubelet-use-node-status-port=true
|
||||
|
||||
# Using hostNetwork often helps in restricted CNI/DNS environments
|
||||
#hostNetwork: true
|
||||
# Required when hostNetwork is true so DNS works as expected
|
||||
#dnsPolicy: ClusterFirstWithHostNet
|
||||
|
||||
# Enable metrics API service monitor if Prometheus Operator is present (optional)
|
||||
# serviceMonitor:
|
||||
# enabled: true
|
||||
@@ -16,6 +16,12 @@ terraform {
|
||||
}
|
||||
}
|
||||
|
||||
resource "kubernetes_namespace" "rabbitmq_namespace" {
|
||||
metadata {
|
||||
name = "rabbitmq-system"
|
||||
}
|
||||
}
|
||||
|
||||
|
||||
resource "helm_release" "rabbitmq_operator" {
|
||||
name = "rabbitmq-cluster-operator"
|
||||
@@ -24,8 +30,7 @@ resource "helm_release" "rabbitmq_operator" {
|
||||
|
||||
version = "4.4.34"
|
||||
|
||||
namespace = "rabbitmq-system"
|
||||
create_namespace = true
|
||||
namespace = "rabbitmq-system"
|
||||
|
||||
# Zde můžete přepsat výchozí hodnoty chartu, pokud by bylo potřeba
|
||||
# Například sledovat jen určité namespace, nastavit tolerations atd.
|
||||
@@ -59,6 +64,7 @@ resource "helm_release" "rabbitmq_operator" {
|
||||
value = "true"
|
||||
}
|
||||
]
|
||||
depends_on = [kubernetes_namespace.rabbitmq_namespace]
|
||||
}
|
||||
|
||||
|
||||
|
||||
@@ -2,4 +2,4 @@ apiVersion: rabbitmq.com/v1beta1
|
||||
kind: RabbitmqCluster
|
||||
metadata:
|
||||
name: 'rabbitmq-cluster'
|
||||
namespace: "rabbitmq"
|
||||
namespace: "rabbitmq-system"
|
||||
|
||||
@@ -2,7 +2,7 @@ apiVersion: networking.cfargotunnel.com/v1alpha1
|
||||
kind: TunnelBinding
|
||||
metadata:
|
||||
name: rabbit-tunnel-binding
|
||||
namespace: rabbitmq
|
||||
namespace: rabbitmq-system
|
||||
subjects:
|
||||
- name: rabbit-gui
|
||||
spec:
|
||||
|
||||
@@ -108,3 +108,40 @@ variable "rabbitmq-password" {
|
||||
sensitive = true
|
||||
description = "Admin password for RabbitMQ user"
|
||||
}
|
||||
|
||||
variable "s3_key_id" {
|
||||
description = "S3 Key ID for backups"
|
||||
type = string
|
||||
sensitive = true
|
||||
nullable = false
|
||||
}
|
||||
|
||||
variable "s3_key_secret" {
|
||||
description = "S3 Key Secret for backups"
|
||||
type = string
|
||||
sensitive = true
|
||||
nullable = false
|
||||
}
|
||||
|
||||
variable "s3_enabled" {
|
||||
description = "Enable S3 backups"
|
||||
type = bool
|
||||
}
|
||||
|
||||
variable "s3_endpoint" {
|
||||
description = "S3 endpoint for backups"
|
||||
type = string
|
||||
}
|
||||
|
||||
variable "s3_region" {
|
||||
description = "S3 region for backups"
|
||||
type = string
|
||||
}
|
||||
|
||||
variable "s3_bucket" {
|
||||
description = "S3 bucket name for backups"
|
||||
type = string
|
||||
}
|
||||
|
||||
|
||||
|
||||
|
||||
Reference in New Issue
Block a user