services/

Docker Compose Environment

🐳 Local development and simple deployment environment using Docker Compose orchestration.

🚀 Features

• Go Fiber API Gateway - High-performance HTTP framework with built-in middleware
• Redis Cluster - Master-slave replication with Redis Sentinel for high availability
• MySQL Database - Relational database with GORM ORM integration
• Prometheus - Metrics collection and monitoring
• Grafana - Data visualization and dashboards with automatic datasource implementation
• Redis Insight - Redis GUI for database management
• Docker Compose - Complete container orchestration
• Makefile - Simplified development commands

📋 Prerequisites

• Docker and Docker Compose
• Go 1.24.4 or higher
• Git

🏗️ Architecture

┌─────────────────┐    ┌─────────────────┐    ┌─────────────────┐
│   API Gateway   │    │     Grafana     │    │   Prometheus    │
│   (Go Fiber)    │    │   (Port 3000)   │    │   (Port 9090)   │
│   (Port 8000)   │    │                 │    │                 │
└─────────────────┘    └─────────────────┘    └─────────────────┘
         │                       │                       │
         └───────────────────────┼───────────────────────┘
                                 │
         ┌─────────────────────────────────────────────────┐
         │              Redis Cluster                      │
         │  ┌─────────┐ ┌─────────┐ ┌─────────┐ ┌─────────┐ │
         │  │  Master │ │  Slave  │ │Sentinel1│ │Sentinel2│ │
         │  │ (6379)  │ │ (6379)  │ │ (26379) │ │ (26380) │ │
         │  └─────────┘ └─────────┘ └─────────┘ └─────────┘ │
         │                    │                    │         │
         │              ┌─────────┐         ┌─────────┐     │
         │              │Sentinel3│         │Redis    │     │
         │              │(26381)  │         │Insight  │     │
         │              └─────────┘         │(5540)   │     │
         └──────────────────────────────────┴─────────┴─────┘
                                 │
         ┌─────────────────────────────────────────────────┐
         │              MySQL Database                     │
         │              (Port 3306)                        │
         └─────────────────────────────────────────────────┘

🚀 Quick Start

1. Clone the repository

   git clone https://github.com/XDcobra/gofiber-starter-stack.git
   cd gofiber-starter-stack
   

2. Initialize Go module (if needed)

   cd services/api-gateway
   go mod init github.com/XDcobra/gofiber-starter-stack
   go mod tidy
   cd ../..
   

3. Create environment file

   cp .env.example .env
   # Edit .env with your configuration
   

4. Start all services

   make docker-start
   

5. Access the services

   • API Gateway: http://localhost:8000
   • Grafana: http://localhost:3000
   • Prometheus: http://localhost:9090
   • Redis Insight: http://localhost:5540
   • MySQL: localhost:3306

6. For Production: Review Security settings

   • Please read section 🔐 Authentication & Security and change the passwords (and usernames) within the .env file, as well as reviewing the exposed service ports

📁 Project Structure

services/
├── api-gateway/                # Go Fiber API Gateway
│   ├── controller/             # HTTP controllers
│   │   ├── DummyController/    # Example controller
│   │   ├── MySQLController/    # MySQL operations
│   │   └── RedisController/    # Redis operations
│   ├── database/               # Database connections
│   │   ├── MySQL/              # MySQL connection & models
│   │   └── Redis/              # Redis connection
│   ├── model/                  # Data models
│   ├── prometheus/             # Metrics configuration
│   ├── router/                 # Route definitions
│   ├── services/               # Business logic
│   ├── Dockerfile              # API Gateway container
│   ├── go.mod                  # Go dependencies
│   └── main.go                 # Application entry point
├── grafana/                    # Grafana configuration
├── mysql/                      # MySQL initialization
├── prometheus/                 # Prometheus configuration
└── dummy_service*/             # Example microservices that you can add in the future

🔧 API Endpoints

Health Check

• GET / - API health check

Redis Operations

• GET /redis/ping - Redis connection test
• GET /redis/get - Get value from Redis
• POST /redis/post - Set value in Redis

MySQL Operations

• GET /mysql/get/:id - Get record by ID
• POST /mysql/post - Create new record

Prometheus Metrics

• GET /metrics - Get the raw prometheus exported data

🔐 Authentication & Security

Password Protected Endpoints

Environment Variables for Authentication

# Golang API Gateway metrics endpoint
METRICS_USER='metrics_user'
METRICS_PASS='metrics_password'

# Prometheus Authentication
PROM_USER='prometheus_user'
PROM_PASS='prometheus_password'

# Grafana Authentication  
GF_SECURITY_ADMIN_USER='admin'
GF_SECURITY_ADMIN_PASSWORD='password'

# MySQL Authentication
MYSQL_ROOT_PASSWORD='root_password'
MYSQL_USER='user'
MYSQL_PASSWORD='password'

# MySQL Database name
MYSQL_DATABASE='example_db'

Default Credentials

• Prometheus: Use the values from PROM_USER and PROM_PASS in your .env file
• Grafana:
  • Username: admin
  • Password: Value of GF_SECURITY_ADMIN_PASSWORD in your .env file
• MySQL:
  • Root Password: Value of MYSQL_ROOT_PASSWORD in your .env file
  • User Password: Value of MYSQL_PASSWORD in your .env file

Security Notes

• API Gateway endpoints are currently public - implement authentication middleware for production
• Redis Insight has no authentication by default - consider adding reverse proxy with auth
• Prometheus and Grafana use basic authentication - ensure strong passwords in production
• MySQL uses database-level authentication - keep credentials secure
• Docker exposes all service ports at the moment - for production builds, consider to only expose the service ports that should be reachable from the outside (e.g. remove redis-sentinel from being reachable from outside as it is not needed normally)

🐳 Docker Services

🛠️ Development Commands

# Start all services
make docker-start

# Stop all services
make docker-stop

# Stop and remove containers
make docker-down

# View logs
docker-compose logs -f

# Rebuild specific service
docker-compose build api-gateway

📊 Monitoring & Observability

Prometheus Metrics

The API Gateway automatically exposes metrics at /metrics endpoint:

• HTTP request duration
• Request count by status code
• Active connections
• Custom business metrics

In case you want to expose more custom metrics, consider to add these into the Gofiber-Prometheus file

Grafana Dashboards

Pre-configured dashboards for:

• API Gateway performance
• Redis cluster health
• MySQL database metrics
• System resource usage

🔄 Redis Cluster Configuration

The Redis setup includes:

• Master-Slave Replication for data redundancy
• Redis Sentinel for automatic failover
• Redis Insight for visual management
• High Availability with automatic master election

🗄️ Database Setup

MySQL

• Automatic schema migration with GORM
• Connection pooling
• Transaction support
• Model auto-generation

Redis

• Connection pooling
• Automatic reconnection
• Sentinel support for HA
• Pub/Sub capabilities

🚀 Production Deployment

1. Update environment variables for production
2. Configure SSL/TLS certificates
3. Set up proper logging and log rotation
4. Configure backup strategies for databases
5. Set up monitoring alerts in Grafana
6. Use external volumes for data persistence
7. ServiceAccounts & JWTs for more security instead of BasicAuth

🔗 Related Documentation

• Main README - Overview of the entire project
• Kubernetes/Helm Documentation - Production deployment with Helm