docs

Author: mstgnz

CHANGELOG.md

@@ -0,0 +1,50 @@
+# Changelog
+
+All notable changes to this project will be documented in this file.
+
+## [1.3.0] - 2024-01-15
+### Added
+- Secure file validation using magic bytes for enhanced security
+- Improved image processing with optimized resize operations
+- Redis cache integration for better performance
+- AWS S3 Glacier storage class support
+- Worker pool implementation for concurrent processing
+- Health check endpoint with detailed status
+- Prometheus metrics integration
+
+### Changed
+- Refactored image processing service for better reliability
+- Enhanced error handling with detailed messages
+- Updated logging system with structured logs
+- Improved request validation
+- Optimized cache invalidation strategy
+
+### Fixed
+- Memory leak in image processing operations
+- Concurrent upload handling issues
+- Cache invalidation race conditions
+- File type validation security issues
+- Error handling in batch operations
+
+## [1.2.0] - 2023-12-01
+### Added
+- Basic image processing capabilities
+- MinIO storage integration
+- Simple caching mechanism
+- Basic error handling
+- Initial API endpoints
+
+### Changed
+- Improved file upload process
+- Enhanced storage handling
+- Basic performance optimizations
+
+## [1.1.0] - 2023-09-15
+### Added
+- Initial MinIO integration
+- Basic file upload/download
+- Simple authentication
+
+## [1.0.0] - 2023-06-15
+- Initial release
+- Basic CDN functionality

README.md

@@ -175,92 +175,16 @@ For production deployments, we provide comprehensive Kubernetes configurations w
 
 For detailed instructions, see [Kubernetes Deployment Guide](k8s/README.md)
 
-## Testing
+## Documentation
 
-### Prerequisites for Testing
-The project requires ImageMagick for image processing operations. To ensure a consistent test environment, we recommend running tests inside Docker containers.
+For detailed information, please refer to:
 
-### Running Tests
-
-1. Build and start the containers:
-```bash
-docker-compose up -d
-```
-
-2. Run tests inside the container:
-```bash
-# Run all tests
-docker exec cdn-golang go test ./... -v
-
-# Run specific package tests
-docker exec cdn-golang go test ./pkg/worker -v
-docker exec cdn-golang go test ./service -v
-docker exec cdn-golang go test ./handler -v
-```
-
-3. Run tests with coverage:
-```bash
-docker exec cdn-golang go test ./... -coverprofile=coverage.out
-docker exec cdn-golang go tool cover -html=coverage.out -o coverage.html
-```
-
-### Test Environment
-The test container includes:
-- ImageMagick (latest version, dynamically managed)
-- Redis for caching and rate limiting tests
-- MinIO for storage tests
-- Mock AWS services
-- k6 for load testing
-
-### Test Coverage
-- Unit tests with minimum 80% coverage
-- Integration tests for all endpoints
-- Performance tests using k6
-- Load testing scenarios
-- Automated API testing
-
-### Load Testing
-```bash
-# Run basic load test
-k6 run test/performance/load_test.js
-
-# Run stress test
-k6 run --vus 50 --duration 5m test/performance/load_test.js
-
-# Run spike test
-k6 run --vus 100 --duration 10s test/performance/spike_test.js
-```
-
-## Architecture
-
-The service is built with a modular architecture:
-
-- `cmd/`: Application entry point
-- `handler/`: Request handlers
-- `service/`: Core business logic
-- `pkg/`:
-  - `batch/`: Batch processing
-  - `worker/`: Worker pool
-  - `middleware/`: HTTP middlewares
-  - `observability/`: Monitoring and tracing
-  - `config/`: Configuration management
-
-## Performance Optimizations
-
-- Redis caching for resized images
-- Worker pool for concurrent image processing
-- Batch processing for bulk operations
-- Rate limiting with bypass protection
-- Efficient memory management
-- Dynamic resource allocation
-
-## Contributing
-
-1. Fork the repository
-2. Create your feature branch
-3. Commit your changes
-4. Push to the branch
-5. Create a new Pull Request
+- [Testing Guide](docs/testing.md)
+- [Troubleshooting Guide](docs/troubleshooting.md)
+- [Migration Guide](docs/migration.md)
+- [Changelog](CHANGELOG.md)
+- [Kubernetes Deployment Guide](k8s/README.md)
+- [Contributing](CONTRIBUTING.md)
 
 ## License
 

docs/migration.md

@@ -0,0 +1,35 @@
+# Migration Guide
+
+## Migrating from v1.x to v2.x
+
+1. **Configuration Changes**
+   - Add new environment variables using `.env.example` as reference
+   - Update Redis cache configuration
+
+2. **API Changes**
+   - `/upload` endpoint now expects `multipart/form-data`
+   - Resize parameters moved from query string to form data
+
+3. **Database Changes**
+   - Cache system migrated to Redis
+   - MinIO bucket structure updated
+
+4. **Required Steps**
+   ```bash
+   # 1. Stop the service
+   systemctl stop cdn-service
+
+   # 2. Install new version
+   git pull
+   go build
+
+   # 3. Update configuration
+   cp .env.example .env
+   nano .env
+
+   # 4. Clear cache
+   redis-cli FLUSHALL
+
+   # 5. Start service
+   systemctl start cdn-service
+   ``` 

docs/testing.md

@@ -0,0 +1,59 @@
+# Testing Guide
+
+## Prerequisites
+
+The project requires ImageMagick for image processing operations. To ensure a consistent test environment, we recommend running tests inside Docker containers.
+
+## Running Tests
+
+1. Build and start the containers:
+```bash
+docker-compose up -d
+```
+
+2. Run tests inside the container:
+```bash
+# Run all tests
+docker exec cdn-golang go test ./... -v
+
+# Run specific package tests
+docker exec cdn-golang go test ./pkg/worker -v
+docker exec cdn-golang go test ./service -v
+docker exec cdn-golang go test ./handler -v
+```
+
+3. Run tests with coverage:
+```bash
+docker exec cdn-golang go test ./... -coverprofile=coverage.out
+docker exec cdn-golang go tool cover -html=coverage.out -o coverage.html
+```
+
+## Test Environment
+
+The test container includes:
+- ImageMagick (latest version, dynamically managed)
+- Redis for caching and rate limiting tests
+- MinIO for storage tests
+- Mock AWS services
+- k6 for load testing
+
+## Test Coverage
+
+- Unit tests with minimum 80% coverage
+- Integration tests for all endpoints
+- Performance tests using k6
+- Load testing scenarios
+- Automated API testing
+
+## Load Testing
+
+```bash
+# Run basic load test
+k6 run test/performance/load_test.js
+
+# Run stress test
+k6 run --vus 50 --duration 5m test/performance/load_test.js
+
+# Run spike test
+k6 run --vus 100 --duration 10s test/performance/spike_test.js
+``` 

docs/troubleshooting.md

@@ -0,0 +1,36 @@
+# Troubleshooting Guide
+
+## Common Issues and Solutions
+
+1. **MinIO Connection Issues**
+   - Error: "Unable to connect to MinIO server"
+   - Solution: 
+     - Ensure MinIO service is running
+     - Check MinIO connection details in `.env` file
+     - Verify firewall settings
+
+2. **File Upload Issues**
+   - Error: "File size exceeds limit"
+   - Solution:
+     - Check `BodyLimit` setting (default: 25MB)
+     - If using Nginx, verify `client_max_body_size` setting
+
+3. **Image Processing Issues**
+   - Error: "Image processing failed"
+   - Solution:
+     - Verify ImageMagick is installed
+     - Check if file format is supported
+     - Monitor memory limits
+
+4. **Cache Issues**
+   - Error: "Redis connection failed"
+   - Solution:
+     - Ensure Redis service is running
+     - Verify Redis connection details
+     - Monitor Redis memory usage
+
+## Logging and Monitoring
+
+- Error logs: `/var/log/cdn-service/error.log`
+- Application logs: `/var/log/cdn-service/app.log`
+- Metrics: Available via `/metrics` endpoint for Prometheus