DevOps Integration Microservice

Overview

This project is a Spring Boot microservice named "devops-integration" that demonstrates:

• Full CRUD (Create, Read, Update, Delete) REST API operations
• Input validation
• Global exception handling
• GitHub integration
• Jenkins CI/CD pipeline
• Docker image creation
• Docker-compose.yaml configuration

---

Features

• REST APIs: Supports GET, GET ALL, POST, PUT, DELETE operations.
• Input Validation: Uses @Valid annotations to validate request payloads.
• Global Exception Handling: Centralized error handling with @ControllerAdvice.
• GitHub Integration: Project is hosted on GitHub.
• Jenkins Pipeline: Automates build, test, and deployment processes.
• Docker Support: Docker image creation and deployment.
• Docker Compose: Configuration for running multiple services.

---

API Endpoints

Base URL: http://localhost:9099

Method	Endpoint	Description	Full URL Example
GET	/user/{userId}	Fetch a record by ID	[GET] http://localhost:9099/user/67b56de01ce51a216c9122a
GET	/user	Fetch all records	[GET] http://localhost:9099/user
POST	/user	Create a new record	[POST] http://localhost:9099/user
PUT	/user/{userId}	Update an existing record	[PUT] http://localhost:9099/user/67b56de01ce51a216c9122aa
DELETE	/user/{userId}	Delete a record	[DELETE] http://localhost:9099/user/67b56de01ce51a216c9122aa

Example Request (POST)

{
    "username": "Kishor",
    "email": "Kishorpandey633@gmail.com",
    "password": "Kishor@22",
    "address": {
        "state": "Lumbini",
        "city": "Butwal",
        "zipcode": "YE376"
    }
}

Example Response

{
    "userId": "67b56de01ce51a216c9122aa",
    "username": "Kishor",
    "email": "Kishorpandey633@gmail.com",
    "password": "Kishor@22",
    "address": {
        "state": "Lumbini",
        "city": "Butwal",
        "zipcode": "YE376"
    }
}

Duplicate User Post Request

{
    "username": "Kishor",
    "email": "Kishorpandey633@gmail.com",
    "password": "Kishor@22",
    "address": {
        "state": "Lumbini",
        "city": "Butwal",
        "zipcode": "YE376"
    }
}

Response of Duplicate Data or User

{
    "message": "User Already Exists With Email",
    "status": true
}

Validation Example

{
    "username": "Rajan",
    "email": "Rajan",
    "password": "Rajan",
    "address": {
        "state": "Lumbini",
        "city": "2223",
        "zipcode": "YE376"
    }
}

Validation Response

{
    "password": "Password must contain at least one uppercase letter, one lowercase letter, one number, and one special character",
    "email": "User email is not a valid email address"
}

---

Global Exception Handling

Handled using @ControllerAdvice:

• MethodArgumentNotValidException for validation errors.
• ResourceNotFoundException for non-existent records.
• Exception for generic errors.

---

GitHub Integration

1. Initialize Git repository:

   git init
   git add .
   git commit -m "Initial commit"
   git branch -M main
   git remote add origin https://github.com/Thekishor/devops-integration.git
   git push -u origin main

---

Jenkins CI/CD Pipeline

Jenkinsfile

pipeline{
    agent any
    stages{
        stage('Checkout Code'){
            steps{
                git(
                    url: 'https://github.com/Thekishor/devops-integration.git',
                    branch: 'main',
                    credentialsId: 'git_hub_token'
                )
            }
        }
        
        stage('Build Maven'){
            steps{
                bat 'mvn clean verify'
            }
        }
        
        stage('Build Docker Image'){
            steps{
                script{
                    bat 'docker build -t thekishor/devops-integration:0.0.1 .'
                }
            }
        }
        
        stage('Push image to Hub'){
            steps{
                script{
                    withCredentials([usernamePassword(credentialsId: 'docker_hub_token', usernameVariable: 'DOCKER_USER', passwordVariable: 'DOCKER_PASSWORD')]){
                        bat "docker login -u %DOCKER_USER% -p %DOCKER_PASSWORD%"
                        bat "docker push %DOCKER_USER%/devops-integration:0.0.1"
                    }
                }
            }
        }
    }
}

---

Docker Integration

Dockerfile

FROM openjdk:21-jdk-slim
EXPOSE 9099
ADD target/devops-integration.jar devops-integration.jar
ENTRYPOINT ["java","-jar","/devops-integration.jar"]

Docker Compose

docker-compose.yaml

services:
  devops-integration:
    image: thekishor/devops-integration:0.0.1
    container_name: devops-integration
    ports:
      - '9099:9099'
    environment:
      SPRING_DATA_MONGODB_HOST: mongo
      SPRING_DATA_MONGODB_PORT: 27017
      SPRING_DATA_MONGODB_USERNAME: kishor
      SPRING_DATA_MONGODB_PASSWORD: kishor

    depends_on:
      - mongo
    networks:
      - devops-integration

  mongo:
    image: mongo:latest
    container_name: mongo
    ports:
      - '27017:27017'
    volumes:
      - mongo-data:/data/db
    environment:
      MONGO_INITDB_ROOT_USERNAME: kishor
      MONGO_INITDB_ROOT_PASSWORD: kishor
    networks:
      - devops-integration

networks:
  devops-integration:
    driver: bridge
volumes:
  mongo-data:

Run with Docker Compose

docker-compose up -d

---

Conclusion

This microservice integrates DevOps principles with:

• REST API development
• CI/CD using Jenkins
• Containerization with Docker
• Automated service deployment via Docker Compose