shared-dg05-unicorn/phonebill
1
0
Fork 0
mirror of https://github.com/cna-bootcamp/phonebill.git synced 2025-12-05 23:56:23 +00:00
Code Issues Packages Projects Releases Wiki Activity

GitHub Actions 백엔드 CI/CD 파이프라인 구축

Browse Source 
🚀 주요 변경사항:
- Kustomize 기반 환경별(dev/staging/prod) 매니페스트 관리
- SonarQube 코드 품질 분석 통합
- 환경별 Docker 이미지 빌드 및 푸시
- AKS 자동 배포 워크플로우
- 수동 배포 스크립트 추가

📁 생성된 파일:
- GitHub Actions 워크플로우: .github/workflows/backend-cicd.yaml
- Kustomize Base: 23개 파일
- Kustomize Overlays: dev(12), staging(12), prod(12)
- 환경별 설정 파일: 3개
- 배포 스크립트: 1개
- 가이드 문서: 1개

✨ 주요 기능:
- 환경별 독립적 설정 (replicas, resources, secrets)
- SonarQube Quality Gate 검증 (선택적)
- 롤백 지원 (GitHub Actions, kubectl, 수동 스크립트)
- HTTPS 지원 (staging/prod)

🤖 Generated with [Claude Code](https://claude.com/claude-code)

Co-Authored-By: Claude <noreply@anthropic.com>
This commit is contained in:
hiondal 2025-10-01 10:27:22 +09:00
parent a99b121545
commit dcb8794b63
33 changed files with 664 additions and 604 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

714
.github/actions-pipeline-guide.md vendored
View File

@ -1,254 +1,534 @@
# GitHub Actions CI/CD 파이프라인 구축 가이드
# GitHub Actions 백엔드 CI/CD 파이프라인 가이드
## 📋 개요
## 개요
이 문서는 phonebill 프로젝트의 GitHub Actions 기반 백엔드 CI/CD 파이프라인 구축 가이드입니다.
phonebill 시스템을 위한 GitHub Actions 기반 CI/CD 파이프라인이 성공적으로 구축되었습니다.
**주요 기능:**
- ✅ Gradle 기반 빌드 및 단위 테스트
- ✅ SonarQube 코드 품질 분석 및 Quality Gate 검증
- ✅ 환경별(dev/staging/prod) Docker 이미지 빌드 및 푸시
- ✅ Kustomize 기반 환경별 매니페스트 관리 및 자동 배포
- ✅ 롤백 및 수동 배포 지원
### 프로젝트 정보
- **시스템명**: phonebill
- **서비스**: api-gateway, user-service, bill-service, product-service, kos-mock
- **JDK 버전**: 21
- **Azure 환경**: ACR(acrdigitalgarage01), AKS(aks-digitalgarage-01), RG(rg-digitalgarage-01)
- **네임스페이스**: phonebill-dg0500
---
## 구축된 파일 구조
## 📌 1. 프로젝트 정보
### 시스템 및 서비스 정보
- **시스템명**: `phonebill`
- **서비스 목록**:
- `api-gateway` (API Gateway)
- `user-service` (사용자 인증 및 관리)
- `bill-service` (요금 조회)
- `product-service` (상품 변경)
- `kos-mock` (KOS 연동 Mock)
### 기술 스택
- **JDK**: 21
- **빌드 도구**: Gradle
- **컨테이너**: Docker
- **오케스트레이션**: Kubernetes (AKS)
- **매니페스트 관리**: Kustomize
### 인프라 정보
- **Azure Container Registry**: `acrdigitalgarage01`
- **리소스 그룹**: `rg-digitalgarage-01`
- **AKS 클러스터**: `aks-digitalgarage-01`
- **Namespace**: `phonebill-dg0500`
---
## 🔧 2. 사전 준비사항
### 2.1 Azure 인증 정보 획득
#### Azure Service Principal 생성
```bash
# Azure CLI로 Service Principal 생성
az ad sp create-for-rbac \
--name "github-actions-phonebill" \
--role contributor \
--scopes /subscriptions/{구독ID}/resourceGroups/rg-digitalgarage-01 \
--json-auth
# 출력 예시 (이 JSON을 AZURE_CREDENTIALS Secret으로 등록)
{
"clientId": "5e4b5b41-7208-48b7-b821-d6d5acf50ecf",
"clientSecret": "ldu8Q~GQEzFYU.dJX7_QsahR7n7C2xqkIM6hqbV8",
"subscriptionId": "2513dd36-7978-48e3-9a7c-b221d4874f66",
"tenantId": "4f0a3bfd-1156-4cce-8dc2-a049a13dba23"
}
```
#### ACR Credentials 획득
```bash
# ACR 패스워드 확인
az acr credential show --name acrdigitalgarage01
# 출력 결과에서 username과 password 확인
```
### 2.2 SonarQube 설정
#### SONAR_HOST_URL 확인
```bash
# SonarQube 서비스 External IP 확인
kubectl get svc -n sonarqube
# 출력 예시:
# NAME TYPE EXTERNAL-IP PORT(S)
# sonarqube-sonarqube LoadBalancer 20.249.187.69 9000:30234/TCP
# SONAR_HOST_URL: http://20.249.187.69
```
#### SONAR_TOKEN 생성
1. SonarQube에 로그인 (http://{EXTERNAL_IP})
2. 우측 상단 **Administrator** > **My Account** 클릭
3. **Security** 탭 선택
4. **Generate Tokens**에서 새 토큰 생성
5. 토큰 값 복사 (한 번만 표시됨)
### 2.3 Docker Hub 인증 (Rate Limit 방지)
1. Docker Hub (https://hub.docker.com) 로그인
2. 우측 상단 프로필 아이콘 > **Account Settings**
3. 좌측 메뉴 **Personal Access Tokens** 클릭
4. **Generate New Token** 버튼으로 토큰 생성
5. Token 값 복사
---
## 🔐 3. GitHub Repository 설정
### 3.1 Repository Secrets 설정
**경로**: Repository Settings > Secrets and variables > Actions > Repository secrets
| Secret 이름 | 설명 | 예시 값 |
|------------|------|---------|
| `AZURE_CREDENTIALS` | Azure Service Principal JSON | 위 2.1 참조 |
| `ACR_USERNAME` | ACR 사용자명 | `acrdigitalgarage01` |
| `ACR_PASSWORD` | ACR 패스워드 | `az acr credential show` 결과 |
| `SONAR_HOST_URL` | SonarQube 서버 URL | `http://20.249.187.69` |
| `SONAR_TOKEN` | SonarQube 인증 토큰 | 위 2.2 참조 |
| `DOCKERHUB_USERNAME` | Docker Hub 사용자명 | 본인 Docker Hub ID |
| `DOCKERHUB_PASSWORD` | Docker Hub 패스워드/토큰 | 위 2.3 참조 |
**AZURE_CREDENTIALS 예시:**
```json
{
"clientId": "5e4b5b41-7208-48b7-b821-d6d5acf50ecf",
"clientSecret": "ldu8Q~GQEzFYU.dJX7_QsahR7n7C2xqkIM6hqbV8",
"subscriptionId": "2513dd36-7978-48e3-9a7c-b221d4874f66",
"tenantId": "4f0a3bfd-1156-4cce-8dc2-a049a13dba23"
}
```
### 3.2 Repository Variables 설정
**경로**: Repository Settings > Secrets and variables > Actions > Variables > Repository variables
| Variable 이름 | 설명 | 기본값 |
|--------------|------|--------|
| `ENVIRONMENT` | 배포 환경 | `dev` |
| `SKIP_SONARQUBE` | SonarQube 분석 건너뛰기 | `true` |
**사용 방법:**
- **자동 실행** (Push/PR): 기본값 사용 (`ENVIRONMENT=dev`, `SKIP_SONARQUBE=true`)
- **수동 실행**: Actions 탭 > "Backend Services CI/CD" > "Run workflow" 버튼
- Environment: `dev` / `staging` / `prod` 선택
- Skip SonarQube Analysis: `true` / `false` 선택
---
## 📂 4. 디렉토리 구조
```
.github/
├── kustomize/
│ ├── base/
├── kustomize/ # Kustomize 매니페스트
│ ├── base/ # Base 매니페스트
│ │ ├── kustomization.yaml
│ │ ├── common/
│ │ ├── common/ # 공통 리소스
│ │ │ ├── cm-common.yaml
│ │ │ ├── secret-common.yaml
│ │ │ ├── secret-imagepull.yaml
│ │ │ └── ingress.yaml
│ │ └── {서비스명}/
│ │ ├── api-gateway/
│ │ │ ├── deployment.yaml
│ │ │ └── service.yaml
│ │ ├── user-service/
│ │ │ ├── deployment.yaml
│ │ │ ├── service.yaml
│ │ │ ├── cm-user-service.yaml
│ │ │ └── secret-user-service.yaml
│ │ ├── bill-service/
│ │ │ ├── deployment.yaml
│ │ │ ├── service.yaml
│ │ │ ├── cm-bill-service.yaml
│ │ │ └── secret-bill-service.yaml
│ │ ├── product-service/
│ │ │ ├── deployment.yaml
│ │ │ ├── service.yaml
│ │ │ ├── cm-product-service.yaml
│ │ │ └── secret-product-service.yaml
│ │ └── kos-mock/
│ │ ├── deployment.yaml
│ │ ├── service.yaml
│ │ ├── cm-{서비스명}.yaml
│ │ └── secret-{서비스명}.yaml (해당되는 경우)
│ └── overlays/
│ │ └── cm-kos-mock.yaml
│ └── overlays/ # 환경별 Overlay
│ ├── dev/
│ │ ├── kustomization.yaml
│ │ ├── cm-common-patch.yaml
│ │ ├── ingress-patch.yaml
│ │ ├── deployment-{서비스명}-patch.yaml
│ │ ├── secret-common-patch.yaml
│ │ └── secret-{서비스명}-patch.yaml
│ ├── staging/
│ │ └── (dev와 동일한 구조, staging 환경 설정)
│ └── prod/
│ └── (dev와 동일한 구조, prod 환경 설정)
├── config/
│ │ ├── ingress-patch.yaml
│ │ ├── deployment-api-gateway-patch.yaml
│ │ ├── deployment-user-service-patch.yaml
│ │ ├── secret-user-service-patch.yaml
│ │ ├── deployment-bill-service-patch.yaml
│ │ ├── secret-bill-service-patch.yaml
│ │ ├── deployment-product-service-patch.yaml
│ │ ├── secret-product-service-patch.yaml
│ │ ├── deployment-kos-mock-patch.yaml
│ │ └── cm-kos-mock-patch.yaml
│ ├── staging/ # staging도 dev와 동일 구조
│ └── prod/ # prod도 dev와 동일 구조
├── config/ # 환경별 설정
│ ├── deploy_env_vars_dev
│ ├── deploy_env_vars_staging
│ └── deploy_env_vars_prod
├── scripts/
├── scripts/ # 배포 스크립트
│ └── deploy-actions.sh
└── workflows/
└── workflows/ # GitHub Actions 워크플로우
└── backend-cicd.yaml
```
## GitHub Repository 설정
---
### 1. Repository Secrets 설정
## 🚀 5. 파이프라인 구조
GitHub Repository → Settings → Secrets and variables → Actions → Repository secrets에 다음 설정:
### 5.1 워크플로우 단계
```bash
# Azure Service Principal
AZURE_CREDENTIALS
{
"clientId": "{클라이언트ID}",
"clientSecret": "{클라이언트시크릿}",
"subscriptionId": "{구독ID}",
"tenantId": "{테넌트ID}"
}
# ACR Credentials (az acr credential show --name acrdigitalgarage01)
ACR_USERNAME: acrdigitalgarage01
ACR_PASSWORD: {ACR패스워드}
# SonarQube 설정
SONAR_HOST_URL: http://{External IP} # k get svc -n sonarqube로 확인
SONAR_TOKEN: {SonarQube토큰} # SonarQube > My Account > Security에서 생성
# Docker Hub (Rate Limit 방지)
DOCKERHUB_USERNAME: {Docker Hub 사용자명}
DOCKERHUB_PASSWORD: {Docker Hub 패스워드}
```mermaid
graph LR
A[Push/PR] --> B[Build & Test]
B --> C{SonarQube<br/>Skip?}
C -->|No| D[SonarQube Analysis]
C -->|Yes| E[Skip Analysis]
D --> F[Quality Gate]
E --> F
F --> G[Build Docker Images]
G --> H[Push to ACR]
H --> I[Deploy to AKS]
I --> J[Health Check]
```
### 2. Repository Variables 설정
### 5.2 Job 구성
GitHub Repository → Settings → Secrets and variables → Actions → Variables → Repository variables에 다음 설정:
1. **build**: 빌드 및 테스트
- Gradle 빌드
- JUnit 단위 테스트
- SonarQube 분석 (선택적)
- 빌드 아티팩트 업로드
```bash
ENVIRONMENT: dev (기본값)
SKIP_SONARQUBE: true (기본값)
```
2. **release**: Docker 이미지 빌드 및 푸시
- 빌드 아티팩트 다운로드
- Docker 이미지 빌드
- ACR에 푸시 (환경별 태그)
## 파이프라인 실행 방법
### 1. 자동 실행
- **트리거**: main/develop 브랜치에 push 또는 main 브랜치에 PR
- **환경**: dev (기본값)
- **SonarQube**: 스킵 (기본값)
### 2. 수동 실행
1. GitHub → Actions 탭 이동
2. "Backend Services CI/CD" 워크플로우 선택
3. "Run workflow" 버튼 클릭
4. 환경 선택 (dev/staging/prod)
5. SonarQube 분석 여부 선택 (true/false)
## 파이프라인 단계
### 1. Build and Test
- Gradle 빌드 (테스트 제외)
- SonarQube 코드 품질 분석 (선택사항)
- 빌드 아티팩트 업로드
### 2. Build and Push Docker Images
- 각 서비스별 Docker 이미지 빌드
- Azure Container Registry에 푸시
- 이미지 태그: `{환경}-{타임스탬프}`
### 3. Deploy to Kubernetes
- Kustomize를 사용한 환경별 매니페스트 생성
- AKS 클러스터에 배포
- 배포 상태 확인
## 환경별 설정
### DEV 환경
- **Replicas**: 1
- **Resources**: requests(256Mi/256m), limits(1024Mi/1024m)
- **DDL**: update
- **SSL**: 비활성화
- **Host**: phonebill-dg0500-api.20.214.196.128.nip.io
### STAGING 환경
- **Replicas**: 2
- **Resources**: requests(512Mi/512m), limits(2048Mi/2048m)
- **DDL**: validate
- **SSL**: 활성화
- **Host**: phonebill-staging.digitalgarage.com
- **JWT**: 운영 환경 토큰 유효시간
### PROD 환경
- **Replicas**: 3
- **Resources**: requests(1024Mi/1024m), limits(4096Mi/4096m)
- **DDL**: validate
- **SSL**: 활성화
- **Host**: phonebill.digitalgarage.com
- **JWT**: 보안 강화된 짧은 토큰 유효시간
## 수동 배포 방법
로컬에서 수동 배포를 수행하려면:
```bash
# 기본 dev 환경으로 배포
./.github/scripts/deploy-actions.sh
# 특정 환경과 이미지 태그로 배포
./.github/scripts/deploy-actions.sh staging 20241001123000
# 권한 오류 시
chmod +x .github/scripts/deploy-actions.sh
```
## 롤백 방법
### 1. GitHub Actions를 통한 롤백
1. GitHub → Actions → 성공한 이전 워크플로우 선택
2. "Re-run all jobs" 클릭
### 2. kubectl을 이용한 롤백
```bash
# 이전 버전으로 롤백
kubectl rollout undo deployment/{서비스명} -n phonebill-dg0500 --to-revision=2
# 롤백 상태 확인
kubectl rollout status deployment/{서비스명} -n phonebill-dg0500
```
### 3. 수동 스크립트를 이용한 롤백
```bash
# 이전 안정 버전 이미지 태그로 배포
./.github/scripts/deploy-actions.sh {환경} {이전태그}
```
## SonarQube Quality Gate 설정
각 서비스별 프로젝트 생성 후 다음 Quality Gate 설정:
```
Coverage: >= 80%
Duplicated Lines: <= 3%
Maintainability Rating: <= A
Reliability Rating: <= A
Security Rating: <= A
```
## 모니터링 및 확인
### 배포 상태 확인
```bash
# Pod 상태 확인
kubectl get pods -n phonebill-dg0500
# 서비스 상태 확인
kubectl get services -n phonebill-dg0500
# Ingress 상태 확인
kubectl get ingress -n phonebill-dg0500
# 로그 확인
kubectl logs -f deployment/{서비스명} -n phonebill-dg0500
```
### 헬스 체크
```bash
# API Gateway 헬스 체크
curl -f http://phonebill-dg0500-api.20.214.196.128.nip.io/actuator/health
```
## 주요 특징
1. **환경별 분리**: dev, staging, prod 환경별 독립적인 설정
2. **Kustomize 사용**: 환경별 매니페스트 관리 자동화
3. **SonarQube 통합**: 코드 품질 분석 및 Quality Gate
4. **Docker 최적화**: Multi-stage 빌드 및 Rate Limit 방지
5. **자동 배포**: Push/PR 시 자동 빌드 및 배포
6. **수동 배포**: 운영진이 필요 시 수동 실행 가능
7. **롤백 지원**: 다양한 방법의 롤백 기능
## 문제 해결
### 일반적인 오류
1. **Azure 인증 실패**
- AZURE_CREDENTIALS 설정 확인
- Service Principal 권한 확인
2. **ACR 접근 실패**
- ACR_USERNAME, ACR_PASSWORD 확인
- ACR 권한 설정 확인
3. **SonarQube 분석 실패**
- SONAR_TOKEN, SONAR_HOST_URL 확인
- SonarQube 서버 접근성 확인
4. **Kustomize 오류**
- patch 파일 경로 및 target 확인
- YAML 문법 오류 확인
### 연락처
문제 발생 시 DevOps 팀에 문의하거나 GitHub Issues를 통해 보고해 주세요.
3. **deploy**: Kubernetes 배포
- AKS 인증
- Kustomize로 매니페스트 생성
- kubectl로 배포
- Health Check
---
**최운영/데옵스**: GitHub Actions CI/CD 파이프라인 구축이 완료되었습니다! 🎉
## 📝 6. Kustomize 설계 원칙
### 6.1 Base 매니페스트
- 모든 환경에서 공통으로 사용되는 리소스 정의
- 네임스페이스 하드코딩 **제거** (Overlay에서 지정)
- 이미지 태그는 `latest`로 기본값 설정
### 6.2 Overlay Patch 원칙
**⚠️ 중요 원칙:**
1. **Base에 없는 항목 추가 금지**: Patch는 기존 항목만 수정
2. **Base와 항목 일치 필수**: 구조가 정확히 일치해야 함
3. **Secret은 `stringData` 사용**: `data`(base64) 대신 평문 사용
4. **Patch 방법**: `patches` + `target` 명시 (deprecated `patchesStrategicMerge` 사용 안함)
### 6.3 환경별 차이
| 항목 | dev | staging | prod |
|------|-----|---------|------|
| **Replicas** | 1 | 2 | 3 |
| **CPU Request** | 256m | 512m | 1024m |
| **Memory Request** | 256Mi | 512Mi | 1024Mi |
| **CPU Limit** | 1024m | 2048m | 4096m |
| **Memory Limit** | 1024Mi | 2048Mi | 4096Mi |
| **DDL Auto** | update | validate | validate |
| **JWT Expiration** | 3600000 (1h) | 3600000 (1h) | 1800000 (30m) |
| **Ingress HTTPS** | false | true | true |
| **Profile** | dev | staging | prod |
---
## 🔄 7. 배포 플로우
### 7.1 자동 배포 (Push/PR)
```bash
# main 또는 develop 브랜치에 Push
git add .
git commit -m "feat: 새로운 기능 추가"
git push origin main
# GitHub Actions 자동 실행
# 1. Build & Test (SKIP_SONARQUBE=true)
# 2. Docker Build & Push (dev-{timestamp} 태그)
# 3. Deploy to dev environment
```
### 7.2 수동 배포 (GitHub UI)
1. GitHub Repository > **Actions** 탭
2. **Backend Services CI/CD** 워크플로우 선택
3. **Run workflow** 버튼 클릭
4. 옵션 선택:
- **Environment**: `dev` / `staging` / `prod`
- **Skip SonarQube Analysis**: `true` / `false`
5. **Run workflow** 실행
### 7.3 로컬 수동 배포 (CLI)
```bash
# 배포 스크립트 실행
cd /path/to/phonebill
.github/scripts/deploy-actions.sh {환경} {이미지태그}
# 예시: dev 환경에 20250101120000 태그 배포
.github/scripts/deploy-actions.sh dev 20250101120000
# 예시: prod 환경에 latest 배포
.github/scripts/deploy-actions.sh prod latest
```
---
## 🔙 8. 롤백 방법
### 8.1 GitHub Actions로 롤백
1. GitHub Repository > **Actions** 탭
2. **성공한 이전 워크플로우** 선택
3. **Re-run all jobs** 버튼 클릭
### 8.2 kubectl로 롤백
```bash
# 이전 버전으로 즉시 롤백
kubectl rollout undo deployment/dev-user-service -n phonebill-dg0500
# 특정 리비전으로 롤백
kubectl rollout history deployment/dev-user-service -n phonebill-dg0500
kubectl rollout undo deployment/dev-user-service -n phonebill-dg0500 --to-revision=2
# 롤백 상태 확인
kubectl rollout status deployment/dev-user-service -n phonebill-dg0500
```
### 8.3 수동 스크립트로 롤백
```bash
# 안정적인 이전 이미지 태그로 재배포
.github/scripts/deploy-actions.sh dev 20241231235959
```
---
## 🧪 9. SonarQube 설정
### 9.1 Quality Gate 기준
| 지표 | 임계값 |
|------|--------|
| **Coverage** | ≥ 80% |
| **Duplicated Lines** | ≤ 3% |
| **Maintainability Rating** | ≤ A |
| **Reliability Rating** | ≤ A |
| **Security Rating** | ≤ A |
### 9.2 프로젝트 생성
각 서비스별로 환경별 프로젝트 생성:
- `phonebill-api-gateway-dev`
- `phonebill-user-service-dev`
- `phonebill-bill-service-dev`
- `phonebill-product-service-dev`
- `phonebill-kos-mock-dev`
- `phonebill-api-gateway-staging`
- ...
- `phonebill-api-gateway-prod`
- ...
### 9.3 분석 실행
```bash
# 모든 서비스 분석 (로컬 테스트)
./gradlew test jacocoTestReport sonar \
-Dsonar.projectKey=phonebill-user-service-dev \
-Dsonar.projectName=phonebill-user-service-dev \
-Dsonar.host.url=http://20.249.187.69 \
-Dsonar.token={YOUR_TOKEN}
```
---
## ✅ 10. 체크리스트
### 10.1 사전 준비
- [ ] Azure Service Principal 생성 완료
- [ ] ACR Credentials 확인 완료
- [ ] SonarQube 토큰 생성 완료
- [ ] Docker Hub 토큰 생성 완료
- [ ] GitHub Repository Secrets 등록 완료
- [ ] GitHub Repository Variables 등록 완료
### 10.2 Kustomize Base
- [ ] `.github/kustomize/base/` 디렉토리 생성
- [ ] 기존 `deployment/k8s/` 파일 복사 완료
- [ ] 네임스페이스 하드코딩 제거 완료
- [ ] `base/kustomization.yaml` 생성 완료
- [ ] `kubectl kustomize .github/kustomize/base/` 정상 실행 확인
### 10.3 Kustomize Overlay (dev)
- [ ] `.github/kustomize/overlays/dev/kustomization.yaml` 생성
- [ ] `cm-common-patch.yaml` 생성 (dev 프로파일)
- [ ] `secret-common-patch.yaml` 생성
- [ ] `ingress-patch.yaml` 생성 (base와 동일 host)
- [ ] 각 서비스별 `deployment-{service}-patch.yaml` 생성 (replicas=1, resources)
- [ ] 각 서비스별 `secret-{service}-patch.yaml` 생성 (필요시)
- [ ] `kubectl kustomize .github/kustomize/overlays/dev/` 정상 실행 확인
### 10.4 Kustomize Overlay (staging/prod)
- [ ] staging 환경 모든 파일 생성 (replicas=2, HTTPS)
- [ ] prod 환경 모든 파일 생성 (replicas=3, HTTPS, 짧은 JWT)
- [ ] `kubectl kustomize .github/kustomize/overlays/{env}/` 정상 실행 확인
### 10.5 GitHub Actions
- [ ] `.github/workflows/backend-cicd.yaml` 생성
- [ ] JDK 버전 확인 (`java-version: '21'`)
- [ ] 모든 서비스명 치환 확인
- [ ] SKIP_SONARQUBE 조건부 처리 확인
- [ ] 워크플로우 문법 검증 (GitHub에서 자동 검증)
### 10.6 환경 설정 및 스크립트
- [ ] `.github/config/deploy_env_vars_dev` 생성
- [ ] `.github/config/deploy_env_vars_staging` 생성
- [ ] `.github/config/deploy_env_vars_prod` 생성
- [ ] `.github/scripts/deploy-actions.sh` 생성
- [ ] 스크립트 실행 권한 설정 (`chmod +x`)
### 10.7 배포 테스트
- [ ] GitHub Actions 수동 실행 테스트 (dev)
- [ ] 배포 성공 확인 (`kubectl get pods`)
- [ ] Health Check 확인 (`/actuator/health`)
- [ ] 롤백 테스트 수행
- [ ] SonarQube 분석 테스트 (SKIP=false)
---
## 📚 11. 참고 자료
### 11.1 문서
- [Kustomize 공식 문서](https://kustomize.io/)
- [GitHub Actions 문서](https://docs.github.com/en/actions)
- [SonarQube 문서](https://docs.sonarqube.org/)
- [Azure CLI 문서](https://docs.microsoft.com/en-us/cli/azure/)
### 11.2 주요 명령어
```bash
# Kustomize 빌드 확인
kubectl kustomize .github/kustomize/overlays/dev/
# 배포 상태 확인
kubectl get pods -n phonebill-dg0500
kubectl get deployments -n phonebill-dg0500
kubectl get services -n phonebill-dg0500
kubectl get ingress -n phonebill-dg0500
# 로그 확인
kubectl logs -n phonebill-dg0500 deployment/dev-user-service
# Rollout 히스토리 확인
kubectl rollout history deployment/dev-user-service -n phonebill-dg0500
```
---
## 🆘 12. 트러블슈팅
### 12.1 이미지 Pull 실패
**증상**: `ImagePullBackOff` 에러
**원인**: ACR 인증 실패
**해결**:
```bash
# Secret 확인
kubectl get secret secret-imagepull -n phonebill-dg0500 -o yaml
# Secret 재생성
kubectl create secret docker-registry secret-imagepull \
--docker-server=acrdigitalgarage01.azurecr.io \
--docker-username={ACR_USERNAME} \
--docker-password={ACR_PASSWORD} \
-n phonebill-dg0500 --dry-run=client -o yaml | kubectl apply -f -
```
### 12.2 Kustomize 빌드 실패
**증상**: `Error: accumulating resources` 에러
**원인**: YAML 문법 오류 또는 파일 경로 오류
**해결**:
```bash
# 문법 검증
kubectl kustomize .github/kustomize/overlays/dev/ --enable-helm
# 파일 존재 여부 확인
ls -la .github/kustomize/base/
ls -la .github/kustomize/overlays/dev/
```
### 12.3 SonarQube Quality Gate 실패
**증상**: Quality Gate 통과 실패
**원인**: Coverage 부족, 코드 품질 이슈
**해결**:
```bash
# 로컬에서 테스트 커버리지 확인
./gradlew :user-service:test :user-service:jacocoTestReport
# 리포트 확인
open user-service/build/reports/jacoco/test/html/index.html
```
---
## 🎯 13. 다음 단계
1. **모니터링 추가**: Prometheus + Grafana 연동
2. **알림 설정**: Slack/Teams 알림 연동
3. **보안 강화**: Trivy 이미지 스캔 추가
4. **성능 테스트**: JMeter/Gatling 연동
5. **Blue/Green 배포**: 무중단 배포 전략 구현
---
**작성일**: 2025-01-01
**작성자**: DevOps Team
**버전**: 1.0.0

2
.github/config/deploy_env_vars_dev vendored
View File

@ -1,3 +1,3 @@
# dev Environment Configuration
resource_group=rg-digitalgarage-01
cluster_name=aks-digitalgarage-01
cluster_name=aks-digitalgarage-01

2
.github/config/deploy_env_vars_prod vendored
View File

@ -1,3 +1,3 @@
# prod Environment Configuration
resource_group=rg-digitalgarage-01
cluster_name=aks-digitalgarage-01
cluster_name=aks-digitalgarage-01

2
.github/config/deploy_env_vars_staging vendored
View File

@ -1,3 +1,3 @@
# staging Environment Configuration
resource_group=rg-digitalgarage-01
cluster_name=aks-digitalgarage-01
cluster_name=aks-digitalgarage-01

4
.github/kustomize/base/kustomization.yaml vendored
View File

@ -34,7 +34,7 @@ resources:
- product-service/cm-product-service.yaml
- product-service/secret-product-service.yaml
# KOS Mock Service
# KOS Mock
- kos-mock/deployment.yaml
- kos-mock/service.yaml
- kos-mock/cm-kos-mock.yaml
@ -49,4 +49,4 @@ images:
- name: acrdigitalgarage01.azurecr.io/phonebill/product-service
newTag: latest
- name: acrdigitalgarage01.azurecr.io/phonebill/kos-mock
newTag: latest
newTag: latest

6
.github/kustomize/overlays/dev/cm-common-patch.yaml vendored
View File

@ -3,9 +3,9 @@ kind: ConfigMap
metadata:
name: cm-common
data:
CORS_ALLOWED_ORIGINS: "http://localhost:8081,http://localhost:8082,http://localhost:8083,http://localhost:8084,http://phonebill-dg0500-api.20.214.196.128.nip.io"
JWT_ACCESS_TOKEN_VALIDITY: "18000000"
CORS_ALLOWED_ORIGINS: "http://localhost:8081,http://localhost:8082,http://localhost:8083,http://localhost:8084,http://phonebill-dg0500.20.214.196.128.nip.io"
JWT_ACCESS_TOKEN_VALIDITY: "3600000"
JWT_REFRESH_TOKEN_VALIDITY: "86400000"
REDIS_PORT: "6379"
SPRING_PROFILES_ACTIVE: "dev"
DDL_AUTO: "update"
DDL_AUTO: "update"

2
.github/kustomize/overlays/dev/deployment-api-gateway-patch.yaml vendored
View File

@ -14,4 +14,4 @@ spec:
cpu: "256m"
limits:
memory: "1024Mi"
cpu: "1024m"
cpu: "1024m"

2
.github/kustomize/overlays/dev/deployment-bill-service-patch.yaml vendored
View File

@ -14,4 +14,4 @@ spec:
cpu: "256m"
limits:
memory: "1024Mi"
cpu: "1024m"
cpu: "1024m"

2
.github/kustomize/overlays/dev/deployment-kos-mock-patch.yaml vendored
View File

@ -14,4 +14,4 @@ spec:
cpu: "256m"
limits:
memory: "1024Mi"
cpu: "1024m"
cpu: "1024m"

2
.github/kustomize/overlays/dev/deployment-product-service-patch.yaml vendored
View File

@ -14,4 +14,4 @@ spec:
cpu: "256m"
limits:
memory: "1024Mi"
cpu: "1024m"
cpu: "1024m"

2
.github/kustomize/overlays/dev/deployment-user-service-patch.yaml vendored
View File

@ -14,4 +14,4 @@ spec:
cpu: "256m"
limits:
memory: "1024Mi"
cpu: "1024m"
cpu: "1024m"

2
.github/kustomize/overlays/dev/ingress-patch.yaml vendored
View File

@ -45,4 +45,4 @@ spec:
service:
name: kos-mock
port:
number: 80
number: 80

61
.github/kustomize/overlays/dev/kustomization.yaml vendored
View File

@ -7,51 +7,62 @@ resources:
- ../../base
patches:
# Common patches
- path: cm-common-patch.yaml
target:
kind: ConfigMap
name: cm-common
- path: deployment-api-gateway-patch.yaml
target:
kind: Deployment
name: api-gateway
- path: deployment-user-service-patch.yaml
target:
kind: Deployment
name: user-service
- path: deployment-bill-service-patch.yaml
target:
kind: Deployment
name: bill-service
- path: deployment-product-service-patch.yaml
target:
kind: Deployment
name: product-service
- path: deployment-kos-mock-patch.yaml
target:
kind: Deployment
name: kos-mock
- path: ingress-patch.yaml
target:
kind: Ingress
name: phonebill
- path: secret-common-patch.yaml
target:
kind: Secret
name: secret-common
- path: ingress-patch.yaml
target:
kind: Ingress
name: phonebill
# API Gateway patches
- path: deployment-api-gateway-patch.yaml
target:
kind: Deployment
name: api-gateway
# User Service patches
- path: deployment-user-service-patch.yaml
target:
kind: Deployment
name: user-service
- path: secret-user-service-patch.yaml
target:
kind: Secret
name: secret-user-service
# Bill Service patches
- path: deployment-bill-service-patch.yaml
target:
kind: Deployment
name: bill-service
- path: secret-bill-service-patch.yaml
target:
kind: Secret
name: secret-bill-service
# Product Service patches
- path: deployment-product-service-patch.yaml
target:
kind: Deployment
name: product-service
- path: secret-product-service-patch.yaml
target:
kind: Secret
name: secret-product-service
# KOS Mock patches
- path: deployment-kos-mock-patch.yaml
target:
kind: Deployment
name: kos-mock
images:
- name: acrdigitalgarage01.azurecr.io/phonebill/api-gateway
newTag: dev-latest
@ -62,4 +73,4 @@ images:
- name: acrdigitalgarage01.azurecr.io/phonebill/product-service
newTag: dev-latest
- name: acrdigitalgarage01.azurecr.io/phonebill/kos-mock
newTag: dev-latest
newTag: dev-latest

2
.github/kustomize/overlays/dev/secret-common-patch.yaml vendored
View File

@ -6,4 +6,4 @@ type: Opaque
stringData:
JWT_SECRET: "nwe5Yo9qaJ6FBD/Thl2/j6/SFAfNwUorAY1ZcWO2KI7uA4bmVLOCPxE9hYuUpRCOkgV2UF2DdHXtqHi3+BU/ecbz2zpHyf/720h48UbA3XOMYOX1sdM+dQ=="
REDIS_HOST: "redis-cache-dev-master"
REDIS_PASSWORD: "Redis2025Dev@"
REDIS_PASSWORD: "Redis2025Dev@"

2
.github/kustomize/overlays/dev/secret-product-service-patch.yaml vendored
View File

@ -7,4 +7,4 @@ stringData:
DB_HOST: "product-change-postgres-dev-postgresql"
DB_NAME: "product_change_db"
DB_USERNAME: "product_change_user"
DB_PASSWORD: "ProductUser2025@"
DB_PASSWORD: "ProductUser2025@"

2
.github/kustomize/overlays/dev/secret-user-service-patch.yaml vendored
View File

@ -7,4 +7,4 @@ stringData:
DB_HOST: "auth-postgres-dev-postgresql"
DB_NAME: "phonebill_auth"
DB_USERNAME: "auth_user"
DB_PASSWORD: "AuthUser2025@"
DB_PASSWORD: "AuthUser2025@"

8
.github/kustomize/overlays/prod/cm-common-patch.yaml vendored
View File

@ -3,9 +3,9 @@ kind: ConfigMap
metadata:
name: cm-common
data:
CORS_ALLOWED_ORIGINS: "https://phonebill.digitalgarage.com,https://phonebill-prod.digitalgarage.com"
JWT_ACCESS_TOKEN_VALIDITY: "3600000"
JWT_REFRESH_TOKEN_VALIDITY: "43200000"
CORS_ALLOWED_ORIGINS: "https://phonebill.example.com"
JWT_ACCESS_TOKEN_VALIDITY: "1800000"
JWT_REFRESH_TOKEN_VALIDITY: "86400000"
REDIS_PORT: "6379"
SPRING_PROFILES_ACTIVE: "prod"
DDL_AUTO: "validate"
DDL_AUTO: "validate"

6
.github/kustomize/overlays/prod/ingress-patch.yaml vendored
View File

@ -10,10 +10,10 @@ spec:
ingressClassName: nginx
tls:
- hosts:
- phonebill.digitalgarage.com
- phonebill.example.com
secretName: phonebill-prod-tls
rules:
- host: phonebill.digitalgarage.com
- host: phonebill.example.com
http:
paths:
- path: /api/v1/auth
@ -50,4 +50,4 @@ spec:
service:
name: kos-mock
port:
number: 80
number: 80

61
.github/kustomize/overlays/prod/kustomization.yaml vendored
View File

@ -7,51 +7,62 @@ resources:
- ../../base
patches:
# Common patches
- path: cm-common-patch.yaml
target:
kind: ConfigMap
name: cm-common
- path: deployment-api-gateway-patch.yaml
target:
kind: Deployment
name: api-gateway
- path: deployment-user-service-patch.yaml
target:
kind: Deployment
name: user-service
- path: deployment-bill-service-patch.yaml
target:
kind: Deployment
name: bill-service
- path: deployment-product-service-patch.yaml
target:
kind: Deployment
name: product-service
- path: deployment-kos-mock-patch.yaml
target:
kind: Deployment
name: kos-mock
- path: ingress-patch.yaml
target:
kind: Ingress
name: phonebill
- path: secret-common-patch.yaml
target:
kind: Secret
name: secret-common
- path: ingress-patch.yaml
target:
kind: Ingress
name: phonebill
# API Gateway patches
- path: deployment-api-gateway-patch.yaml
target:
kind: Deployment
name: api-gateway
# User Service patches
- path: deployment-user-service-patch.yaml
target:
kind: Deployment
name: user-service
- path: secret-user-service-patch.yaml
target:
kind: Secret
name: secret-user-service
# Bill Service patches
- path: deployment-bill-service-patch.yaml
target:
kind: Deployment
name: bill-service
- path: secret-bill-service-patch.yaml
target:
kind: Secret
name: secret-bill-service
# Product Service patches
- path: deployment-product-service-patch.yaml
target:
kind: Deployment
name: product-service
- path: secret-product-service-patch.yaml
target:
kind: Secret
name: secret-product-service
# KOS Mock patches
- path: deployment-kos-mock-patch.yaml
target:
kind: Deployment
name: kos-mock
images:
- name: acrdigitalgarage01.azurecr.io/phonebill/api-gateway
newTag: prod-latest
@ -62,4 +73,4 @@ images:
- name: acrdigitalgarage01.azurecr.io/phonebill/product-service
newTag: prod-latest
- name: acrdigitalgarage01.azurecr.io/phonebill/kos-mock
newTag: prod-latest
newTag: prod-latest

4
.github/kustomize/overlays/prod/secret-bill-service-patch.yaml vendored
View File

@ -4,7 +4,7 @@ metadata:
name: secret-bill-service
type: Opaque
stringData:
DB_HOST: "bill-inquiry-postgres-dev-postgresql"
DB_HOST: "bill-inquiry-postgres-prod-postgresql"
DB_NAME: "bill_inquiry_db"
DB_USERNAME: "bill_inquiry_user"
DB_PASSWORD: "BillUser2025@"
DB_PASSWORD: "BillUserProd2025@"

4
.github/kustomize/overlays/prod/secret-common-patch.yaml vendored
View File

@ -5,5 +5,5 @@ metadata:
type: Opaque
stringData:
JWT_SECRET: "nwe5Yo9qaJ6FBD/Thl2/j6/SFAfNwUorAY1ZcWO2KI7uA4bmVLOCPxE9hYuUpRCOkgV2UF2DdHXtqHi3+BU/ecbz2zpHyf/720h48UbA3XOMYOX1sdM+dQ=="
REDIS_HOST: "redis-cache-dev-master"
REDIS_PASSWORD: "Redis2025Dev@"
REDIS_HOST: "redis-cache-prod-master"
REDIS_PASSWORD: "Redis2025Prod@"

4
.github/kustomize/overlays/prod/secret-product-service-patch.yaml vendored
View File

@ -4,7 +4,7 @@ metadata:
name: secret-product-service
type: Opaque
stringData:
DB_HOST: "product-change-postgres-dev-postgresql"
DB_HOST: "product-change-postgres-prod-postgresql"
DB_NAME: "product_change_db"
DB_USERNAME: "product_change_user"
DB_PASSWORD: "ProductUser2025@"
DB_PASSWORD: "ProductUserProd2025@"

4
.github/kustomize/overlays/prod/secret-user-service-patch.yaml vendored
View File

@ -4,7 +4,7 @@ metadata:
name: secret-user-service
type: Opaque
stringData:
DB_HOST: "auth-postgres-dev-postgresql"
DB_HOST: "auth-postgres-prod-postgresql"
DB_NAME: "phonebill_auth"
DB_USERNAME: "auth_user"
DB_PASSWORD: "AuthUser2025@"
DB_PASSWORD: "AuthUserProd2025@"

6
.github/kustomize/overlays/staging/cm-common-patch.yaml vendored
View File

@ -3,9 +3,9 @@ kind: ConfigMap
metadata:
name: cm-common
data:
CORS_ALLOWED_ORIGINS: "https://phonebill.staging.digitalgarage.com,https://phonebill-staging.digitalgarage.com"
JWT_ACCESS_TOKEN_VALIDITY: "18000000"
CORS_ALLOWED_ORIGINS: "https://phonebill-staging.example.com"
JWT_ACCESS_TOKEN_VALIDITY: "3600000"
JWT_REFRESH_TOKEN_VALIDITY: "86400000"
REDIS_PORT: "6379"
SPRING_PROFILES_ACTIVE: "staging"
DDL_AUTO: "validate"
DDL_AUTO: "validate"

6
.github/kustomize/overlays/staging/ingress-patch.yaml vendored
View File

@ -10,10 +10,10 @@ spec:
ingressClassName: nginx
tls:
- hosts:
- phonebill-staging.digitalgarage.com
- phonebill-staging.example.com
secretName: phonebill-staging-tls
rules:
- host: phonebill-staging.digitalgarage.com
- host: phonebill-staging.example.com
http:
paths:
- path: /api/v1/auth
@ -50,4 +50,4 @@ spec:
service:
name: kos-mock
port:
number: 80
number: 80

61
.github/kustomize/overlays/staging/kustomization.yaml vendored
View File

@ -7,51 +7,62 @@ resources:
- ../../base
patches:
# Common patches
- path: cm-common-patch.yaml
target:
kind: ConfigMap
name: cm-common
- path: deployment-api-gateway-patch.yaml
target:
kind: Deployment
name: api-gateway
- path: deployment-user-service-patch.yaml
target:
kind: Deployment
name: user-service
- path: deployment-bill-service-patch.yaml
target:
kind: Deployment
name: bill-service
- path: deployment-product-service-patch.yaml
target:
kind: Deployment
name: product-service
- path: deployment-kos-mock-patch.yaml
target:
kind: Deployment
name: kos-mock
- path: ingress-patch.yaml
target:
kind: Ingress
name: phonebill
- path: secret-common-patch.yaml
target:
kind: Secret
name: secret-common
- path: ingress-patch.yaml
target:
kind: Ingress
name: phonebill
# API Gateway patches
- path: deployment-api-gateway-patch.yaml
target:
kind: Deployment
name: api-gateway
# User Service patches
- path: deployment-user-service-patch.yaml
target:
kind: Deployment
name: user-service
- path: secret-user-service-patch.yaml
target:
kind: Secret
name: secret-user-service
# Bill Service patches
- path: deployment-bill-service-patch.yaml
target:
kind: Deployment
name: bill-service
- path: secret-bill-service-patch.yaml
target:
kind: Secret
name: secret-bill-service
# Product Service patches
- path: deployment-product-service-patch.yaml
target:
kind: Deployment
name: product-service
- path: secret-product-service-patch.yaml
target:
kind: Secret
name: secret-product-service
# KOS Mock patches
- path: deployment-kos-mock-patch.yaml
target:
kind: Deployment
name: kos-mock
images:
- name: acrdigitalgarage01.azurecr.io/phonebill/api-gateway
newTag: staging-latest
@ -62,4 +73,4 @@ images:
- name: acrdigitalgarage01.azurecr.io/phonebill/product-service
newTag: staging-latest
- name: acrdigitalgarage01.azurecr.io/phonebill/kos-mock
newTag: staging-latest
newTag: staging-latest

4
.github/kustomize/overlays/staging/secret-bill-service-patch.yaml vendored
View File

@ -4,7 +4,7 @@ metadata:
name: secret-bill-service
type: Opaque
stringData:
DB_HOST: "bill-inquiry-postgres-dev-postgresql"
DB_HOST: "bill-inquiry-postgres-staging-postgresql"
DB_NAME: "bill_inquiry_db"
DB_USERNAME: "bill_inquiry_user"
DB_PASSWORD: "BillUser2025@"
DB_PASSWORD: "BillUserStaging2025@"

4
.github/kustomize/overlays/staging/secret-common-patch.yaml vendored
View File

@ -5,5 +5,5 @@ metadata:
type: Opaque
stringData:
JWT_SECRET: "nwe5Yo9qaJ6FBD/Thl2/j6/SFAfNwUorAY1ZcWO2KI7uA4bmVLOCPxE9hYuUpRCOkgV2UF2DdHXtqHi3+BU/ecbz2zpHyf/720h48UbA3XOMYOX1sdM+dQ=="
REDIS_HOST: "redis-cache-dev-master"
REDIS_PASSWORD: "Redis2025Dev@"
REDIS_HOST: "redis-cache-staging-master"
REDIS_PASSWORD: "Redis2025Staging@"

4
.github/kustomize/overlays/staging/secret-product-service-patch.yaml vendored
View File

@ -4,7 +4,7 @@ metadata:
name: secret-product-service
type: Opaque
stringData:
DB_HOST: "product-change-postgres-dev-postgresql"
DB_HOST: "product-change-postgres-staging-postgresql"
DB_NAME: "product_change_db"
DB_USERNAME: "product_change_user"
DB_PASSWORD: "ProductUser2025@"
DB_PASSWORD: "ProductUserStaging2025@"

4
.github/kustomize/overlays/staging/secret-user-service-patch.yaml vendored
View File

@ -4,7 +4,7 @@ metadata:
name: secret-user-service
type: Opaque
stringData:
DB_HOST: "auth-postgres-dev-postgresql"
DB_HOST: "auth-postgres-staging-postgresql"
DB_NAME: "phonebill_auth"
DB_USERNAME: "auth_user"
DB_PASSWORD: "AuthUser2025@"
DB_PASSWORD: "AuthUserStaging2025@"

2
.github/scripts/deploy-actions.sh vendored Executable file → Normal file
View File

@ -61,4 +61,4 @@ kubectl get pods -n phonebill-dg0500
kubectl get services -n phonebill-dg0500
kubectl get ingress -n phonebill-dg0500
echo "✅ GitHub Actions deployment completed successfully!"
echo "✅ GitHub Actions deployment completed successfully!"

23
.github/workflows/backend-cicd.yaml vendored
View File

@ -38,13 +38,15 @@ env:
IMAGE_ORG: phonebill
RESOURCE_GROUP: rg-digitalgarage-01
AKS_CLUSTER: aks-digitalgarage-01
NAMESPACE: phonebill-dg0500
jobs:
build:
name: Build and Test
runs-on: ubuntu-latest
outputs:
image_tag: ${{ steps.set_outputs.outputs.image_tag }}
#image_tag: ${{ steps.set_outputs.outputs.image_tag }}
image_tag: dg0500
environment: ${{ steps.set_outputs.outputs.environment }}
steps:
@ -129,8 +131,8 @@ jobs:
# Run tests, coverage reports, and SonarQube analysis for each service
for service in "${services[@]}"; do
./gradlew :$service:test :$service:jacocoTestReport :$service:sonar \
-Dsonar.projectKey=phonebill-$service-dg0500 \
-Dsonar.projectName=phonebill-$service-dg0500 \
-Dsonar.projectKey=phonebill-$service-${{ steps.determine_env.outputs.environment }} \
-Dsonar.projectName=phonebill-$service-${{ steps.determine_env.outputs.environment }} \
-Dsonar.host.url=$SONAR_HOST_URL \
-Dsonar.token=$SONAR_TOKEN \
-Dsonar.java.binaries=build/classes/java/main \
@ -153,8 +155,7 @@ jobs:
id: set_outputs
run: |
# Generate timestamp for image tag
#IMAGE_TAG=$(date +%Y%m%d%H%M%S)
IMAGE_TAG=dg0500
IMAGE_TAG=$(date +%Y%m%d%H%M%S)
echo "image_tag=$IMAGE_TAG" >> $GITHUB_OUTPUT
echo "environment=${{ steps.determine_env.outputs.environment }}" >> $GITHUB_OUTPUT
@ -244,7 +245,7 @@ jobs:
- name: Create namespace
run: |
kubectl create namespace phonebill-dg0500 --dry-run=client -o yaml | kubectl apply -f -
kubectl create namespace ${{ env.NAMESPACE }} --dry-run=client -o yaml | kubectl apply -f -
- name: Install Kustomize
run: |
@ -269,8 +270,8 @@ jobs:
- name: Wait for deployments to be ready
run: |
echo "Waiting for deployments to be ready..."
kubectl -n phonebill-dg0500 wait --for=condition=available deployment/api-gateway --timeout=300s
kubectl -n phonebill-dg0500 wait --for=condition=available deployment/user-service --timeout=300s
kubectl -n phonebill-dg0500 wait --for=condition=available deployment/bill-service --timeout=300s
kubectl -n phonebill-dg0500 wait --for=condition=available deployment/product-service --timeout=300s
kubectl -n phonebill-dg0500 wait --for=condition=available deployment/kos-mock --timeout=300s
kubectl -n ${{ env.NAMESPACE }} wait --for=condition=available deployment/api-gateway --timeout=300s
kubectl -n ${{ env.NAMESPACE }} wait --for=condition=available deployment/user-service --timeout=300s
kubectl -n ${{ env.NAMESPACE }} wait --for=condition=available deployment/bill-service --timeout=300s
kubectl -n ${{ env.NAMESPACE }} wait --for=condition=available deployment/product-service --timeout=300s
kubectl -n ${{ env.NAMESPACE }} wait --for=condition=available deployment/kos-mock --timeout=300s

254
.github/workflows/backend-cicd_ArgoCD.yaml vendored
View File

@ -1,254 +0,0 @@
name: Backend Services CI/CD
on:
push:
branches: [ main, develop ]
paths:
- 'api-gateway/**'
- 'user-service/**'
- 'bill-service/**'
- 'product-service/**'
- 'kos-mock/**'
- 'common/**'
- '.github/**'
pull_request:
branches: [ main ]
workflow_dispatch:
inputs:
ENVIRONMENT:
description: 'Target environment'
required: true
default: 'dev'
type: choice
options:
- dev
- staging
- prod
SKIP_SONARQUBE:
description: 'Skip SonarQube Analysis'
required: false
default: 'true'
type: choice
options:
- 'true'
- 'false'
env:
REGISTRY: acrdigitalgarage01.azurecr.io
IMAGE_ORG: phonebill
RESOURCE_GROUP: rg-digitalgarage-01
AKS_CLUSTER: aks-digitalgarage-01
jobs:
build:
name: Build and Test
runs-on: ubuntu-latest
outputs:
image_tag: ${{ steps.set_outputs.outputs.image_tag }}
environment: ${{ steps.set_outputs.outputs.environment }}
steps:
- name: Check out code
uses: actions/checkout@v4
- name: Set up JDK 21
uses: actions/setup-java@v3
with:
java-version: '21'
distribution: 'temurin'
cache: 'gradle'
- name: Determine environment
id: determine_env
run: |
# Use input parameter or default to 'dev'
ENVIRONMENT="${{ github.event.inputs.ENVIRONMENT || 'dev' }}"
echo "environment=$ENVIRONMENT" >> $GITHUB_OUTPUT
- name: Load environment variables
id: env_vars
run: |
ENV=${{ steps.determine_env.outputs.environment }}
# Initialize variables with defaults
REGISTRY="acrdigitalgarage01.azurecr.io"
IMAGE_ORG="phonebill"
RESOURCE_GROUP="rg-digitalgarage-01"
AKS_CLUSTER="aks-digitalgarage-01"
NAMESPACE="phonebill-dg0500"
# Read environment variables from .github/config file
if [[ -f ".github/config/deploy_env_vars_${ENV}" ]]; then
while IFS= read -r line || [[ -n "$line" ]]; do
# Skip comments and empty lines
[[ "$line" =~ ^#.*$ ]] && continue
[[ -z "$line" ]] && continue
# Extract key-value pairs
key=$(echo "$line" | cut -d '=' -f1)
value=$(echo "$line" | cut -d '=' -f2-)
# Override defaults if found in config
case "$key" in
"resource_group") RESOURCE_GROUP="$value" ;;
"cluster_name") AKS_CLUSTER="$value" ;;
esac
done < ".github/config/deploy_env_vars_${ENV}"
fi
# Export for other jobs
echo "REGISTRY=$REGISTRY" >> $GITHUB_ENV
echo "IMAGE_ORG=$IMAGE_ORG" >> $GITHUB_ENV
echo "RESOURCE_GROUP=$RESOURCE_GROUP" >> $GITHUB_ENV
echo "AKS_CLUSTER=$AKS_CLUSTER" >> $GITHUB_ENV
- name: Grant execute permission for gradlew
run: chmod +x gradlew
- name: Build with Gradle
run: |
./gradlew build -x test
- name: SonarQube Analysis & Quality Gate
env:
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
SONAR_TOKEN: ${{ secrets.SONAR_TOKEN }}
SONAR_HOST_URL: ${{ secrets.SONAR_HOST_URL }}
run: |
# Check if SonarQube should be skipped
SKIP_SONARQUBE="${{ github.event.inputs.SKIP_SONARQUBE || 'true' }}"
if [[ "$SKIP_SONARQUBE" == "true" ]]; then
echo "⏭️ Skipping SonarQube Analysis (SKIP_SONARQUBE=$SKIP_SONARQUBE)"
exit 0
fi
# Define services array
services=(api-gateway user-service bill-service product-service kos-mock)
# Run tests, coverage reports, and SonarQube analysis for each service
for service in "${services[@]}"; do
./gradlew :$service:test :$service:jacocoTestReport :$service:sonar \
-Dsonar.projectKey=phonebill-$service-dg0500 \
-Dsonar.projectName=phonebill-$service-dg0500 \
-Dsonar.host.url=$SONAR_HOST_URL \
-Dsonar.token=$SONAR_TOKEN \
-Dsonar.java.binaries=build/classes/java/main \
-Dsonar.coverage.jacoco.xmlReportPaths=build/reports/jacoco/test/jacocoTestReport.xml \
-Dsonar.exclusions=**/config/**,**/entity/**,**/dto/**,**/*Application.class,**/exception/**
done
- name: Upload build artifacts
uses: actions/upload-artifact@v4
with:
name: app-builds
path: |
api-gateway/build/libs/*.jar
user-service/build/libs/*.jar
bill-service/build/libs/*.jar
product-service/build/libs/*.jar
kos-mock/build/libs/*.jar
- name: Set outputs
id: set_outputs
run: |
# Generate timestamp for image tag
#IMAGE_TAG=$(date +%Y%m%d%H%M%S)
IMAGE_TAG=dg0500
echo "image_tag=$IMAGE_TAG" >> $GITHUB_OUTPUT
echo "environment=${{ steps.determine_env.outputs.environment }}" >> $GITHUB_OUTPUT
release:
name: Build and Push Docker Images
needs: build
runs-on: ubuntu-latest
steps:
- name: Check out code
uses: actions/checkout@v4
- name: Download build artifacts
uses: actions/download-artifact@v4
with:
name: app-builds
- name: Set environment variables from build job
run: |
echo "REGISTRY=${{ env.REGISTRY }}" >> $GITHUB_ENV
echo "IMAGE_ORG=${{ env.IMAGE_ORG }}" >> $GITHUB_ENV
echo "ENVIRONMENT=${{ needs.build.outputs.environment }}" >> $GITHUB_ENV
echo "IMAGE_TAG=${{ needs.build.outputs.image_tag }}" >> $GITHUB_ENV
- name: Set up Docker Buildx
uses: docker/setup-buildx-action@v3
- name: Login to Docker Hub (prevent rate limit)
uses: docker/login-action@v3
with:
username: ${{ secrets.DOCKERHUB_USERNAME }}
password: ${{ secrets.DOCKERHUB_PASSWORD }}
- name: Login to Azure Container Registry
uses: docker/login-action@v3
with:
registry: ${{ env.REGISTRY }}
username: ${{ secrets.ACR_USERNAME }}
password: ${{ secrets.ACR_PASSWORD }}
- name: Build and push Docker images for all services
run: |
# Define services array
services=(api-gateway user-service bill-service product-service kos-mock)
# Build and push each service image
for service in "${services[@]}"; do
echo "Building and pushing $service..."
docker build \
--build-arg BUILD_LIB_DIR="$service/build/libs" \
--build-arg ARTIFACTORY_FILE="$service.jar" \
-f deployment/container/Dockerfile-backend \
-t ${{ env.REGISTRY }}/${{ env.IMAGE_ORG }}/$service:${{ needs.build.outputs.environment }}-${{ needs.build.outputs.image_tag }} .
docker push ${{ env.REGISTRY }}/${{ env.IMAGE_ORG }}/$service:${{ needs.build.outputs.environment }}-${{ needs.build.outputs.image_tag }}
done
update-manifest:
name: Update Manifest Repository
needs: [build, release]
runs-on: ubuntu-latest
steps:
- name: Set image tag environment variable
run: |
echo "IMAGE_TAG=${{ needs.build.outputs.image_tag }}" >> $GITHUB_ENV
echo "ENVIRONMENT=${{ needs.build.outputs.environment }}" >> $GITHUB_ENV
- name: Update Manifest Repository
run: |
# 매니페스트 레포지토리 클론
REPO_URL=$(echo "https://github.com/cna-bootcamp/phonebill-manifest.git" | sed 's|https://||')
git clone https://${{ secrets.GIT_USERNAME }}:${{ secrets.GIT_PASSWORD }}@${REPO_URL} manifest-repo
cd manifest-repo
# Kustomize 설치
curl -s "https://raw.githubusercontent.com/kubernetes-sigs/kustomize/master/hack/install_kustomize.sh" | bash
sudo mv kustomize /usr/local/bin/
# 매니페스트 업데이트
cd phonebill/kustomize/overlays/${{ env.ENVIRONMENT }}
# 각 서비스별 이미지 태그 업데이트
services="api-gateway user-service bill-service product-service kos-mock"
for service in $services; do
kustomize edit set image acrdigitalgarage01.azurecr.io/phonebill/$service:${{ env.ENVIRONMENT }}-${{ env.IMAGE_TAG }}
done
# Git 설정 및 푸시
cd ../../../..
git config user.name "GitHub Actions"
git config user.email "actions@github.com"
git add .
git commit -m "🚀 Update phonebill ${{ env.ENVIRONMENT }} images to ${{ env.ENVIRONMENT }}-${{ env.IMAGE_TAG }}"
git push origin main
echo "✅ 매니페스트 업데이트 완료. ArgoCD가 자동으로 배포합니다."