completed local setup with compose
Some checks failed
CI/CD Pipeline / Generate SBOM (push) Has been cancelled
CI/CD Pipeline / Deploy to Staging (push) Has been cancelled
CI/CD Pipeline / Deploy to Production (push) Has been cancelled
CI/CD Pipeline / Code Quality & Linting (push) Has been cancelled
CI/CD Pipeline / Policy Validation (push) Has been cancelled
CI/CD Pipeline / Test Suite (push) Has been cancelled
CI/CD Pipeline / Build Docker Images (svc-coverage) (push) Has been cancelled
CI/CD Pipeline / Build Docker Images (svc-extract) (push) Has been cancelled
CI/CD Pipeline / Build Docker Images (svc-firm-connectors) (push) Has been cancelled
CI/CD Pipeline / Build Docker Images (svc-forms) (push) Has been cancelled
CI/CD Pipeline / Build Docker Images (svc-hmrc) (push) Has been cancelled
CI/CD Pipeline / Build Docker Images (svc-ingestion) (push) Has been cancelled
CI/CD Pipeline / Build Docker Images (svc-kg) (push) Has been cancelled
CI/CD Pipeline / Build Docker Images (svc-normalize-map) (push) Has been cancelled
CI/CD Pipeline / Build Docker Images (svc-ocr) (push) Has been cancelled
CI/CD Pipeline / Build Docker Images (svc-rag-indexer) (push) Has been cancelled
CI/CD Pipeline / Build Docker Images (svc-rag-retriever) (push) Has been cancelled
CI/CD Pipeline / Build Docker Images (svc-reason) (push) Has been cancelled
CI/CD Pipeline / Build Docker Images (svc-rpa) (push) Has been cancelled
CI/CD Pipeline / Build Docker Images (ui-review) (push) Has been cancelled
CI/CD Pipeline / Security Scanning (svc-coverage) (push) Has been cancelled
CI/CD Pipeline / Security Scanning (svc-extract) (push) Has been cancelled
CI/CD Pipeline / Security Scanning (svc-kg) (push) Has been cancelled
CI/CD Pipeline / Security Scanning (svc-rag-retriever) (push) Has been cancelled
CI/CD Pipeline / Security Scanning (ui-review) (push) Has been cancelled
CI/CD Pipeline / Notifications (push) Has been cancelled
Some checks failed
CI/CD Pipeline / Generate SBOM (push) Has been cancelled
CI/CD Pipeline / Deploy to Staging (push) Has been cancelled
CI/CD Pipeline / Deploy to Production (push) Has been cancelled
CI/CD Pipeline / Code Quality & Linting (push) Has been cancelled
CI/CD Pipeline / Policy Validation (push) Has been cancelled
CI/CD Pipeline / Test Suite (push) Has been cancelled
CI/CD Pipeline / Build Docker Images (svc-coverage) (push) Has been cancelled
CI/CD Pipeline / Build Docker Images (svc-extract) (push) Has been cancelled
CI/CD Pipeline / Build Docker Images (svc-firm-connectors) (push) Has been cancelled
CI/CD Pipeline / Build Docker Images (svc-forms) (push) Has been cancelled
CI/CD Pipeline / Build Docker Images (svc-hmrc) (push) Has been cancelled
CI/CD Pipeline / Build Docker Images (svc-ingestion) (push) Has been cancelled
CI/CD Pipeline / Build Docker Images (svc-kg) (push) Has been cancelled
CI/CD Pipeline / Build Docker Images (svc-normalize-map) (push) Has been cancelled
CI/CD Pipeline / Build Docker Images (svc-ocr) (push) Has been cancelled
CI/CD Pipeline / Build Docker Images (svc-rag-indexer) (push) Has been cancelled
CI/CD Pipeline / Build Docker Images (svc-rag-retriever) (push) Has been cancelled
CI/CD Pipeline / Build Docker Images (svc-reason) (push) Has been cancelled
CI/CD Pipeline / Build Docker Images (svc-rpa) (push) Has been cancelled
CI/CD Pipeline / Build Docker Images (ui-review) (push) Has been cancelled
CI/CD Pipeline / Security Scanning (svc-coverage) (push) Has been cancelled
CI/CD Pipeline / Security Scanning (svc-extract) (push) Has been cancelled
CI/CD Pipeline / Security Scanning (svc-kg) (push) Has been cancelled
CI/CD Pipeline / Security Scanning (svc-rag-retriever) (push) Has been cancelled
CI/CD Pipeline / Security Scanning (ui-review) (push) Has been cancelled
CI/CD Pipeline / Notifications (push) Has been cancelled
This commit is contained in:
@@ -6,22 +6,23 @@ This document compares the local development environment with the production env
|
||||
|
||||
## Quick Reference
|
||||
|
||||
| Aspect | Local Development | Production |
|
||||
|--------|------------------|------------|
|
||||
| **Domain** | `*.local.lan` | `*.harkon.co.uk` |
|
||||
| **SSL** | Self-signed certificates | Let's Encrypt (GoDaddy DNS) |
|
||||
| **Networks** | `ai-tax-agent-frontend`<br/>`ai-tax-agent-backend` | `frontend`<br/>`backend` |
|
||||
| **Compose File** | `docker-compose.local.yml` | `infrastructure.yaml`<br/>`services.yaml`<br/>`monitoring.yaml` |
|
||||
| **Location** | Local machine | `deploy@141.136.35.199:/opt/ai-tax-agent/` |
|
||||
| **Traefik** | Isolated instance | Shared with company services |
|
||||
| **Authentik** | Isolated instance | Shared with company services |
|
||||
| **Data Persistence** | Local Docker volumes | Remote Docker volumes + backups |
|
||||
| Aspect | Local Development | Production |
|
||||
| -------------------- | -------------------------------------------------- | --------------------------------------------------------------- |
|
||||
| **Domain** | `*.local.lan` | `*.harkon.co.uk` |
|
||||
| **SSL** | Self-signed certificates | Let's Encrypt (GoDaddy DNS) |
|
||||
| **Networks** | `ai-tax-agent-frontend`<br/>`ai-tax-agent-backend` | `frontend`<br/>`backend` |
|
||||
| **Compose File** | `compose.yaml` | `infrastructure.yaml`<br/>`services.yaml`<br/>`monitoring.yaml` |
|
||||
| **Location** | Local machine | `deploy@141.136.35.199:/opt/ai-tax-agent/` |
|
||||
| **Traefik** | Isolated instance | Shared with company services |
|
||||
| **Authentik** | Isolated instance | Shared with company services |
|
||||
| **Data Persistence** | Local Docker volumes | Remote Docker volumes + backups |
|
||||
|
||||
## Detailed Comparison
|
||||
|
||||
### 1. Domain & URLs
|
||||
|
||||
#### Local Development
|
||||
|
||||
```
|
||||
Frontend:
|
||||
- Review UI: https://review.local.lan
|
||||
@@ -42,6 +43,7 @@ Admin Interfaces:
|
||||
```
|
||||
|
||||
#### Production
|
||||
|
||||
```
|
||||
Frontend:
|
||||
- Review UI: https://app.harkon.co.uk
|
||||
@@ -69,6 +71,7 @@ Company Services (shared):
|
||||
### 2. SSL/TLS Configuration
|
||||
|
||||
#### Local Development
|
||||
|
||||
- **Certificate Type**: Self-signed
|
||||
- **Generation**: `scripts/generate-dev-certs.sh`
|
||||
- **Location**: `infra/compose/certs/local.crt`, `infra/compose/certs/local.key`
|
||||
@@ -76,6 +79,7 @@ Company Services (shared):
|
||||
- **Renewal**: Manual (when expired)
|
||||
|
||||
#### Production
|
||||
|
||||
- **Certificate Type**: Let's Encrypt
|
||||
- **Challenge**: DNS-01 (GoDaddy)
|
||||
- **Location**: `/opt/compose/traefik/certs/godaddy-acme.json`
|
||||
@@ -85,6 +89,7 @@ Company Services (shared):
|
||||
### 3. Network Configuration
|
||||
|
||||
#### Local Development
|
||||
|
||||
```yaml
|
||||
networks:
|
||||
frontend:
|
||||
@@ -96,12 +101,14 @@ networks:
|
||||
```
|
||||
|
||||
**Creation**:
|
||||
|
||||
```bash
|
||||
docker network create ai-tax-agent-frontend
|
||||
docker network create ai-tax-agent-backend
|
||||
```
|
||||
|
||||
#### Production
|
||||
|
||||
```yaml
|
||||
networks:
|
||||
frontend:
|
||||
@@ -117,12 +124,14 @@ networks:
|
||||
### 4. Service Isolation
|
||||
|
||||
#### Local Development
|
||||
|
||||
- **Traefik**: Dedicated instance for AI Tax Agent
|
||||
- **Authentik**: Dedicated instance for AI Tax Agent
|
||||
- **Isolation**: Complete - no shared services
|
||||
- **Impact**: Changes don't affect other services
|
||||
|
||||
#### Production
|
||||
|
||||
- **Traefik**: Shared with company services
|
||||
- **Authentik**: Shared with company services
|
||||
- **Isolation**: Partial - infrastructure shared, application isolated
|
||||
@@ -131,14 +140,16 @@ networks:
|
||||
### 5. Authentication & Authorization
|
||||
|
||||
#### Local Development
|
||||
|
||||
- **Bootstrap Admin**: `admin@local.lan` / `admin123`
|
||||
- **Groups**: Auto-created via bootstrap
|
||||
- **OAuth Clients**: Auto-configured
|
||||
- **Users**: Test users only
|
||||
|
||||
#### Production
|
||||
|
||||
- **Bootstrap Admin**: Real admin credentials
|
||||
- **Groups**:
|
||||
- **Groups**:
|
||||
- `company` - Company services access
|
||||
- `app-admin` - Full app access
|
||||
- `app-user` - App user access
|
||||
@@ -149,6 +160,7 @@ networks:
|
||||
### 6. Data Persistence
|
||||
|
||||
#### Local Development
|
||||
|
||||
```bash
|
||||
# Volume location
|
||||
/var/lib/docker/volumes/
|
||||
@@ -168,6 +180,7 @@ networks:
|
||||
**Retention**: Until `make clean`
|
||||
|
||||
#### Production
|
||||
|
||||
```bash
|
||||
# Volume location
|
||||
/var/lib/docker/volumes/
|
||||
@@ -188,6 +201,7 @@ networks:
|
||||
### 7. Environment Variables
|
||||
|
||||
#### Local Development (`.env`)
|
||||
|
||||
```bash
|
||||
DOMAIN=local.lan
|
||||
EMAIL=admin@local.lan
|
||||
@@ -200,6 +214,7 @@ DEVELOPMENT_MODE=true
|
||||
```
|
||||
|
||||
#### Production (`.env.production`)
|
||||
|
||||
```bash
|
||||
DOMAIN=harkon.co.uk
|
||||
EMAIL=admin@harkon.co.uk
|
||||
@@ -214,11 +229,13 @@ DEVELOPMENT_MODE=false
|
||||
### 8. Resource Limits
|
||||
|
||||
#### Local Development
|
||||
|
||||
- **No limits**: Uses available resources
|
||||
- **Suitable for**: Development and testing
|
||||
- **Scaling**: Not configured
|
||||
|
||||
#### Production
|
||||
|
||||
```yaml
|
||||
# Example resource limits
|
||||
services:
|
||||
@@ -226,22 +243,24 @@ services:
|
||||
deploy:
|
||||
resources:
|
||||
limits:
|
||||
cpus: '1.0'
|
||||
cpus: "1.0"
|
||||
memory: 1G
|
||||
reservations:
|
||||
cpus: '0.5'
|
||||
cpus: "0.5"
|
||||
memory: 512M
|
||||
```
|
||||
|
||||
### 9. Logging & Monitoring
|
||||
|
||||
#### Local Development
|
||||
|
||||
- **Logs**: Docker logs (`docker compose logs`)
|
||||
- **Retention**: Until container restart
|
||||
- **Monitoring**: Optional (Grafana available but not required)
|
||||
- **Alerts**: Disabled
|
||||
|
||||
#### Production
|
||||
|
||||
- **Logs**: Centralized in Loki
|
||||
- **Retention**: 30 days
|
||||
- **Monitoring**: Required (Prometheus + Grafana)
|
||||
@@ -250,6 +269,7 @@ services:
|
||||
### 10. Deployment Process
|
||||
|
||||
#### Local Development
|
||||
|
||||
```bash
|
||||
# Start everything
|
||||
make bootstrap
|
||||
@@ -259,7 +279,7 @@ make up
|
||||
./scripts/create-networks.sh
|
||||
./scripts/generate-dev-certs.sh
|
||||
cd infra/compose
|
||||
docker compose -f docker-compose.local.yml up -d
|
||||
docker compose up -d
|
||||
|
||||
# Stop everything
|
||||
make down
|
||||
@@ -269,6 +289,7 @@ make clean
|
||||
```
|
||||
|
||||
#### Production
|
||||
|
||||
```bash
|
||||
# Deploy infrastructure
|
||||
cd /opt/ai-tax-agent
|
||||
@@ -287,11 +308,13 @@ docker compose -f services.yaml up -d --no-deps svc-ingestion
|
||||
### 11. Database Migrations
|
||||
|
||||
#### Local Development
|
||||
|
||||
- **Automatic**: Migrations run on startup
|
||||
- **Rollback**: `make clean` and restart
|
||||
- **Data Loss**: Acceptable
|
||||
|
||||
#### Production
|
||||
|
||||
- **Manual**: Migrations run explicitly
|
||||
- **Rollback**: Requires backup restoration
|
||||
- **Data Loss**: NOT acceptable
|
||||
@@ -299,11 +322,13 @@ docker compose -f services.yaml up -d --no-deps svc-ingestion
|
||||
### 12. Secrets Management
|
||||
|
||||
#### Local Development
|
||||
|
||||
- **Storage**: `.env` file (committed to git as example)
|
||||
- **Vault**: Dev mode (unsealed automatically)
|
||||
- **Security**: Low (development only)
|
||||
|
||||
#### Production
|
||||
|
||||
- **Storage**: `.env.production` (NOT committed to git)
|
||||
- **Vault**: Production mode (manual unseal required)
|
||||
- **Security**: High (encrypted, access controlled)
|
||||
@@ -311,11 +336,13 @@ docker compose -f services.yaml up -d --no-deps svc-ingestion
|
||||
### 13. CI/CD Integration
|
||||
|
||||
#### Local Development
|
||||
|
||||
- **CI/CD**: Not applicable
|
||||
- **Testing**: Manual
|
||||
- **Deployment**: Manual
|
||||
|
||||
#### Production
|
||||
|
||||
- **CI/CD**: Gitea Actions (planned)
|
||||
- **Testing**: Automated (unit, integration, e2e)
|
||||
- **Deployment**: Automated with approval gates
|
||||
@@ -323,12 +350,14 @@ docker compose -f services.yaml up -d --no-deps svc-ingestion
|
||||
### 14. Backup & Recovery
|
||||
|
||||
#### Local Development
|
||||
|
||||
- **Backup**: Not configured
|
||||
- **Recovery**: Rebuild from scratch
|
||||
- **RTO**: N/A
|
||||
- **RPO**: N/A
|
||||
|
||||
#### Production
|
||||
|
||||
- **Backup**: Daily automated backups
|
||||
- **Recovery**: Restore from backup
|
||||
- **RTO**: 1 hour
|
||||
@@ -337,11 +366,13 @@ docker compose -f services.yaml up -d --no-deps svc-ingestion
|
||||
### 15. Cost Considerations
|
||||
|
||||
#### Local Development
|
||||
|
||||
- **Infrastructure**: Free (local machine)
|
||||
- **Compute**: Uses local resources
|
||||
- **Storage**: Uses local disk
|
||||
|
||||
#### Production
|
||||
|
||||
- **Infrastructure**: Server rental (~$50/month)
|
||||
- **Compute**: Shared with company services
|
||||
- **Storage**: Included in server
|
||||
@@ -353,16 +384,19 @@ docker compose -f services.yaml up -d --no-deps svc-ingestion
|
||||
### From Local to Production
|
||||
|
||||
1. **Build images locally**:
|
||||
|
||||
```bash
|
||||
docker compose -f docker-compose.local.yml build
|
||||
docker compose build
|
||||
```
|
||||
|
||||
2. **Tag for production**:
|
||||
|
||||
```bash
|
||||
docker tag svc-ingestion:latest gitea.harkon.co.uk/ai-tax-agent/svc-ingestion:v1.0.0
|
||||
```
|
||||
|
||||
3. **Push to registry**:
|
||||
|
||||
```bash
|
||||
docker push gitea.harkon.co.uk/ai-tax-agent/svc-ingestion:v1.0.0
|
||||
```
|
||||
@@ -378,23 +412,26 @@ docker compose -f services.yaml up -d --no-deps svc-ingestion
|
||||
### From Production to Local (for debugging)
|
||||
|
||||
1. **Pull production image**:
|
||||
|
||||
```bash
|
||||
docker pull gitea.harkon.co.uk/ai-tax-agent/svc-ingestion:v1.0.0
|
||||
```
|
||||
|
||||
2. **Tag for local use**:
|
||||
|
||||
```bash
|
||||
docker tag gitea.harkon.co.uk/ai-tax-agent/svc-ingestion:v1.0.0 svc-ingestion:latest
|
||||
```
|
||||
|
||||
3. **Run locally**:
|
||||
```bash
|
||||
docker compose -f docker-compose.local.yml up -d svc-ingestion
|
||||
docker compose up -d svc-ingestion
|
||||
```
|
||||
|
||||
## Best Practices
|
||||
|
||||
### Local Development
|
||||
|
||||
1. ✅ Use `make` commands for consistency
|
||||
2. ✅ Keep `.env` file updated from `env.example`
|
||||
3. ✅ Run tests before committing
|
||||
@@ -402,6 +439,7 @@ docker compose -f services.yaml up -d --no-deps svc-ingestion
|
||||
5. ✅ Clean up regularly with `make clean`
|
||||
|
||||
### Production
|
||||
|
||||
1. ✅ Never commit `.env.production` to git
|
||||
2. ✅ Always backup before making changes
|
||||
3. ✅ Test in local environment first
|
||||
@@ -413,12 +451,14 @@ docker compose -f services.yaml up -d --no-deps svc-ingestion
|
||||
## Troubleshooting
|
||||
|
||||
### Local Development Issues
|
||||
|
||||
- **Port conflicts**: Check if ports 80, 443, 8080 are in use
|
||||
- **Network errors**: Recreate networks with `make networks`
|
||||
- **Certificate errors**: Regenerate with `./scripts/generate-dev-certs.sh`
|
||||
- **Service won't start**: Check logs with `docker compose logs <service>`
|
||||
|
||||
### Production Issues
|
||||
|
||||
- **Service unreachable**: Check Traefik routing and DNS
|
||||
- **Authentication fails**: Verify Authentik configuration
|
||||
- **SSL errors**: Check certificate renewal in Traefik
|
||||
|
||||
Reference in New Issue
Block a user