Admin processes

📌 Admin Processes (관리 작업 자동화)

(Twelve-Factor App 원칙: 관리 작업도 코드로 관리해야 한다.)

마이크로서비스를 운영하는 동안 데이터 마이그레이션, 배치 작업, 시스템 유지보수 등의 관리 작업이 필요할 수 있습니다.
이러한 관리 작업(Admin Processes)은 일회성(Ad-hoc)으로 실행하는 것이 아니라, 코드로 작성하여 자동화해야 합니다.

🔹 1. Admin Processes(관리 작업)란?

• 마이크로서비스 운영 중 데이터 마이그레이션, 데이터 변환, 배치 작업 등을 수행해야 할 수 있음.
• 이러한 작업을 수동으로 실행하는 것이 아니라, 코드로 작성하여 자동화해야 함.
• 관리 작업을 별도의 소스 코드 저장소(Repository)에 저장하여 추적 가능해야 함.
• 각 환경(개발, 테스트, 운영)에서 동일한 방식으로 실행될 수 있도록 해야 함.

📌 아래 예시는 관리 작업을 스크립트 기반으로 자동화하는 개념을 보여줍니다.

┌─────────────────────────────┐
│ Source Code Repository      │  ← 모든 관리 작업 스크립트 저장
└─────────────────────────────┘
        │
        ▼
┌─────────────────────────────┐
│ Automated Admin Script      │  ← 자동 실행 (데이터 마이그레이션, 유지보수 등)
└─────────────────────────────┘

✅ 관리 작업 스크립트는 Git 등의 코드 저장소에서 관리해야 함.
✅ 각 환경에서 동일한 방식으로 실행될 수 있도록 자동화해야 함.
✅ 수동 작업을 최소화하여 운영 실수를 방지해야 함.

🔹 2. Admin Processes를 자동화하는 방법

✅ (1) 데이터베이스 마이그레이션 자동화

마이크로서비스 운영 중 데이터베이스 스키마 변경이 필요할 수 있습니다.
Flyway 또는 Liquibase 같은 데이터베이스 마이그레이션 도구를 사용하여 이를 자동화할 수 있습니다.

📌 Flyway 설정 예제 (application.yml)

spring:
  flyway:
    enabled: true
    locations: classpath:db/migration

📌 Flyway 마이그레이션 SQL 예제 (V1__create_users_table.sql)

CREATE TABLE users (
    id SERIAL PRIMARY KEY,
    name VARCHAR(255) NOT NULL,
    email VARCHAR(255) UNIQUE NOT NULL
);

📌 Flyway 마이그레이션 실행

mvn flyway:migrate

✅ 데이터베이스 변경 사항을 코드로 관리하여, 모든 환경에서 동일하게 적용 가능.
✅ 운영 환경에서도 동일한 방식으로 마이그레이션을 수행 가능.

✅ (2) 배치 작업 자동화 (Spring Batch 활용)

마이크로서비스에서 정기적으로 실행해야 하는 데이터 처리 작업(예: 보고서 생성, 데이터 정리 등)이 있을 수 있습니다.
이러한 작업을 Spring Batch를 활용하여 자동화할 수 있습니다.

📌 Spring Batch 설정 예제

@Configuration
@EnableBatchProcessing
public class BatchConfig {

    @Bean
    public Job dataProcessingJob(JobRepository jobRepository, Step step) {
        return new JobBuilder("dataProcessingJob", jobRepository)
                .start(step)
                .build();
    }

    @Bean
    public Step dataProcessingStep(JobRepository jobRepository) {
        return new StepBuilder("dataProcessingStep", jobRepository)
                .tasklet((contribution, chunkContext) -> {
                    System.out.println("데이터 처리 작업 실행 중...");
                    return RepeatStatus.FINISHED;
                })
                .build();
    }
}

📌 배치 작업 실행 명령어

java -jar my-microservice.jar --spring.batch.job.names=dataProcessingJob

✅ 배치 작업을 수동으로 실행하는 것이 아니라, 자동화하여 정기적으로 실행 가능.
✅ 운영 환경에서도 동일한 방식으로 실행 가능하도록 설정.

✅ (3) CI/CD 파이프라인에서 관리 작업 자동 실행

GitHub Actions, Jenkins 등을 활용하여 관리 작업을 CI/CD 파이프라인에 포함할 수 있습니다.

📌 GitHub Actions에서 데이터 마이그레이션 자동화

name: Deploy Microservice

on:
  push:
    branches:
      - main

jobs:
  deploy:
    runs-on: ubuntu-latest
    steps:
      - name: Checkout Repository
        uses: actions/checkout@v3

      - name: Run Flyway Migration
        run: mvn flyway:migrate

✅ 코드 변경이 발생하면 자동으로 데이터베이스 마이그레이션이 실행됨.
✅ CI/CD 파이프라인을 활용하여 모든 관리 작업을 자동화할 수 있음.

🔹 3. Admin Processes를 자동화해야 하는 이유

✅ 운영 실수 방지

• 관리 작업을 수동으로 실행하면 환경별 차이로 인해 문제가 발생할 가능성이 높음.
• 코드 기반 자동화를 통해 환경 차이를 줄이고, 실수를 방지할 수 있음.

✅ 재현 가능성 보장

• 모든 관리 작업이 Git 등의 코드 저장소에서 관리되므로, 언제든지 동일한 작업을 실행할 수 있음.
• 이전 작업 이력을 추적하여 문제 발생 시 롤백 가능.

✅ 운영 환경과 동일한 방식으로 실행 가능

• 운영 환경에서도 개발 및 테스트 환경과 동일한 방식으로 관리 작업을 실행할 수 있음.
• CI/CD와 연동하여 배포와 함께 자동으로 실행 가능.

✅ 대규모 마이크로서비스 운영에 필수적

• 마이크로서비스 개수가 많아질수록 수동 관리 작업이 비효율적이고, 오류 발생 가능성이 증가함.
• 모든 관리 작업을 자동화해야 확장성 있는 운영이 가능.

🔹 4. Admin Processes를 따르지 않으면 발생하는 문제

❌ 환경별로 수동으로 관리 작업을 실행하는 경우

# 개발 환경에서 데이터 마이그레이션 실행
psql -U user -d dev_db -f migrate.sql  

# 운영 환경에서 데이터 마이그레이션 실행 (수동)
psql -U user -d prod_db -f migrate.sql  # → 실수로 잘못된 SQL 실행 가능

🚨 문제점:

• 운영 환경에서 수동으로 SQL을 실행하다가 실수로 데이터 손실이 발생할 수 있음.
• 환경마다 관리 작업이 다르게 실행될 가능성이 있음 → 운영 환경에서 예측 불가능한 오류 발생 가능.

✅ 해결 방법:

• 모든 관리 작업을 코드로 작성하여 Git에서 관리해야 함.
• CI/CD 파이프라인에서 자동으로 실행되도록 설정해야 함.

📌 결론: Admin Processes 적용 원칙

1️⃣ 관리 작업(데이터 마이그레이션, 배치 작업 등)은 수동 실행이 아니라 코드 기반 자동화해야 함.
2️⃣ 관리 작업 스크립트는 Git과 같은 소스 코드 저장소에서 관리하여, 모든 환경에서 동일한 방식으로 실행될 수 있어야 함.
3️⃣ 데이터 마이그레이션(Flyway, Liquibase)과 같은 도구를 활용하여, 운영 환경에서도 안전하게 실행되도록 설정해야 함.
4️⃣ 배치 작업(Spring Batch 등)은 자동화하여 일정 주기로 실행되도록 구성해야 함.
5️⃣ CI/CD 파이프라인과 연동하여, 배포와 함께 자동으로 실행될 수 있도록 설정해야 함.

 

🔹 이를 통해 운영 실수를 방지하고, 확장 가능한 마이크로서비스 운영을 실현할 수 있습니다! 🚀