Docs Cleanup

This commit is contained in:
Eric Gullickson
2025-11-03 16:12:29 -06:00
parent 2cc9cc5f9f
commit d8d0ada83f
33 changed files with 158 additions and 2102 deletions

View File

@@ -1,13 +1,13 @@
# MVP Platform Service
# MVP Platform Module
## Overview
The MVP Platform service is an **integrated service** that provides platform capabilities to the MotoVaultPro application. This service is part of the simplified 6-container architecture.
The MVP Platform module is fully integrated inside the MotoVaultPro backend container. It delivers all platform capabilities without requiring a separate service or container in the simplified five-container stack.
## Architecture
The platform service is integrated into the main application stack:
- **Service Container**: mvp-platform
The platform module runs as part of the backend service:
- **Runtime**: `mvp-backend` container (Fastify API)
- **Shared Database**: Uses mvp-postgres
- **Shared Cache**: Uses mvp-redis
@@ -37,18 +37,17 @@ The platform provides vehicle data capabilities including:
**Start All Services**:
```bash
make start # Starts all 6 containers
make start # Starts the five-container stack
```
**Service Logs**:
**Backend Logs (includes platform module)**:
```bash
make logs # All service logs
docker logs mvp-platform
make logs-backend
```
**Service Shell Access**:
**Backend Shell (platform code lives here)**:
```bash
docker exec -it mvp-platform sh
make shell-backend
```
### Database Management
@@ -66,10 +65,10 @@ make db-shell-app
## Deployment Strategy
### Integrated Deployment
The platform service deploys with the main application:
The platform module deploys with the main application:
- Same deployment pipeline
- Shares database and cache
- Deployed as part of 6-container stack
- Deployed as part of the five-container stack
## Integration Patterns
@@ -85,7 +84,7 @@ Application features access platform data through shared database:
**Service Discovery Problems**:
- Verify Docker networking: `docker network ls`
- Check container connectivity: `docker exec -it mvp-platform sh`
- Check backend container connectivity: `docker compose exec mvp-backend sh`
**Database Connection Issues**:
- Verify mvp-postgres is healthy
@@ -93,19 +92,19 @@ Application features access platform data through shared database:
### Health Checks
**Verify Platform Service**:
**Verify Backend Service (contains platform module)**:
```bash
docker ps | grep mvp-platform
docker compose ps mvp-backend
```
### Logs and Debugging
**Service Logs**:
```bash
docker logs mvp-platform --tail=100 -f
docker compose logs -f mvp-backend
```
**Database Logs**:
```bash
docker logs mvp-postgres --tail=100 -f
docker compose logs -f mvp-postgres
```