이 프로젝트에서는 Spring Boot 애플리케이션을 위한 CI/CD 파이프라인을 두 가지 방법으로 구축했습니다:
-
🐳 Jenkins와 Docker를 사용한 방법: 이 방법은 Jenkins를 사용하여 빌드 및 테스트 과정을 자동화하고, Docker를 이용해 애플리케이션을 컨테이너화하여 배포합니다. Watchtower를 사용하여 지속적인 업데이트를 수행합니다.
-
🚀 Jenkins와 직접 EC2 배포 방법: 이 방법은 Jenkins를 사용하여 빌드 및 테스트를 수행한 후, 생성된 JAR 파일을 직접 EC2 인스턴스로 전송하여 실행합니다.
아래에서는 이 두 가지 방법에 대해 자세히 설명합니다.
 |
 |
 |
 |
|---|---|---|---|
| 박지원 @jiione |
최나영 @na-rong |
박현서 @hyleei |
백승지 @seungji2001 |
Spring Boot 애플리케이션의 개발부터 배포까지의 과정을 자동화하는 것입니다. 주요 구성 요소는 다음과 같습니다:
- 🍃 Spring Boot: Java 기반의 웹 애플리케이션
- 🛠️ Jenkins: CI/CD 파이프라인 관리
- 🐳 Docker: 애플리케이션 컨테이너화
- 🏪 Docker Hub: 컨테이너 이미지 저장소
- 🔄 Watchtower: 컨테이너 자동 업데이트
- ☕ Java JDK 17
- 🐘 Gradle
- 🌿 Git
- 🛠️ Jenkins
- 🐳 Docker
- 🏪 Docker Hub 계정
- ☁️ AWS EC2 인스턴스 (또는 다른 호스팅 서비스)
- Jenkins 대시보드에서 새로운 파이프라인 작업을 생성합니다.
- GitHub 저장소와 연결하여 소스 코드 관리를 설정합니다.
- Jenkinsfile을 사용하여 파이프라인을 정의합니다.
FROM openjdk:17-jdk-alpine
WORKDIR /app
COPY build/libs/*.jar app.jar
ENTRYPOINT ["java","-jar","/app/app.jar"]pipeline {
agent any
environment {
DOCKER_IMAGE_NAME = 'hyleei/spring-app'
DOCKER_CREDENTIALS_ID = 'hyleei'
DOCKER_IMAGE_TAG = "${env.BUILD_NUMBER}"
TRIVY_HOME = "${JENKINS_HOME}/trivy"
GRADLE_OPTS = '-Dorg.gradle.daemon=false -Dorg.gradle.parallel=true -Dorg.gradle.caching=true'
}
stages {
stage('Clone Repository') {
steps {
git branch: 'main', url: 'https://github.com/jiione/AWS-CICD-Demo.git'
}
}
stage('Set Permissions') {
steps {
sh 'chmod +x ./gradlew'
}
}
stage('Build JAR') {
steps {
sh './gradlew clean build --no-daemon'
}
}
stage('Build Docker Image') {
steps {
script {
dockerImage = docker.build("${DOCKER_IMAGE_NAME}:${DOCKER_IMAGE_TAG}", "--no-cache .")
}
}
}
stage('Run Trivy Scan') {
steps {
script {
sh """
if ! command -v ${TRIVY_HOME}/trivy &> /dev/null; then
echo "Trivy not found. Installing..."
mkdir -p ${TRIVY_HOME}
curl -sfL https://raw.githubusercontent.com/aquasecurity/trivy/main/contrib/install.sh | sh -s -- -b ${TRIVY_HOME}
fi
${TRIVY_HOME}/trivy image --no-progress --exit-code 0 --severity HIGH,CRITICAL ${DOCKER_IMAGE_NAME}:${DOCKER_IMAGE_TAG}
"""
}
}
}
stage('Push Docker Image') {
steps {
script {
docker.withRegistry('https://registry.hub.docker.com', "${DOCKER_CREDENTIALS_ID}") {
def imageExists = sh(script: "docker manifest inspect ${DOCKER_IMAGE_NAME}:${DOCKER_IMAGE_TAG} > /dev/null 2>&1", returnStatus: true) == 0
if (!imageExists) {
echo "Image ${DOCKER_IMAGE_NAME}:${DOCKER_IMAGE_TAG} does not exist. Pushing..."
def startTime = System.currentTimeMillis()
dockerImage.push("${DOCKER_IMAGE_TAG}")
def latestDigest = sh(script: "docker inspect --format='{{index .RepoDigests 0}}' ${DOCKER_IMAGE_NAME}:latest 2>/dev/null || echo ''", returnStdout: true).trim()
def newDigest = sh(script: "docker inspect --format='{{index .RepoDigests 0}}' ${DOCKER_IMAGE_NAME}:${DOCKER_IMAGE_TAG}", returnStdout: true).trim()
if (latestDigest != newDigest) {
echo "Updating latest tag..."
dockerImage.push("latest")
} else {
echo "Latest tag is up to date. Skipping push."
}
def endTime = System.currentTimeMillis()
def duration = (endTime - startTime) / 1000
echo "Push took ${duration} seconds"
} else {
echo "Image ${DOCKER_IMAGE_NAME}:${DOCKER_IMAGE_TAG} already exists. Skipping push."
}
}
}
}
}
stage('Cleanup') {
steps {
sh "docker rmi ${DOCKER_IMAGE_NAME}:${DOCKER_IMAGE_TAG} || true"
sh "docker rmi ${DOCKER_IMAGE_NAME}:latest || true"
cleanWs()
}
}
}
post {
success {
echo "Pipeline completed successfully."
}
failure {
echo "Pipeline failed. Please check the logs for more information."
}
}
}
Watchtower를 사용하여 컨테이너 자동 업데이트를 구성합니다:
docker run -d \
--name watchtower \
-v /var/run/docker.sock:/var/run/docker.sock \
containrrr/watchtower \
--interval 300 \
spring-app- EC2 인스턴스에 Docker를 설치합니다.
- Spring Boot 애플리케이션 컨테이너를 실행합니다:
docker run -d --name spring-app -p 80:80 chinarong2/spring-app:latest- Watchtower를 실행하여 자동 업데이트를 활성화합니다.
이 방법은 Docker를 사용하지 않고 직접 EC2 인스턴스에 애플리케이션을 배포합니다.
pipeline {
agent any
environment {
EC2_USER = 'ubuntu'
EC2_HOST = ''
KEY_FILE = '/var/jenkins_home/.ssh/my-key.pem'
}
stages {
stage('Clone Repository') {
steps {
git branch: 'main', url: 'https://github.com/jiione/AWS-CICD-Demo.git'
}
}
stage('Set Permissions') {
steps {
sh 'chmod +x ./gradlew'
}
}
stage('Build JAR') {
steps {
sh './gradlew clean build'
}
}
stage('Copy JAR to EC2') {
steps {
sh '''
scp -o StrictHostKeyChecking=no -i ${KEY_FILE} build/libs/*.jar ${EC2_USER}@${EC2_HOST}:/tmp/
'''
}
}
stage('Run JAR on EC2') {
steps {
sh '''
ssh -o StrictHostKeyChecking=no -i ${KEY_FILE} ${EC2_USER}@${EC2_HOST} "nohup java -jar /tmp/*.jar &"
'''
}
}
}
}-
EC2 인스턴스에 Java를 설치합니다:
sudo apt update && sudo apt install openjdk-17-jdk -y -
Jenkins에 EC2 인스턴스의 SSH 키를 등록합니다.
-
Jenkins 파이프라인 설정에서 위의 스크립트를 사용합니다.
-
파이프라인을 실행하면 JAR 파일이 EC2로 전송되고 실행됩니다.
장점:
- Docker 없이 간단한 구성
- 리소스 사용량이 상대적으로 적음
단점:
- 배포 롤백이 어려움
- 환경 일관성 유지가 어려울 수 있음
-
Jenkins 빌드 실패
- 문제: Gradle 빌드 중 "Permission denied" 오류 발생
- 해결: Gradle Wrapper에 실행 권한 부여
chmod +x gradlew
-
Docker 이미지 빌드 실패
- 문제: Docker 빌드 중 "context canceled" 오류 발생
- 해결: Docker 데몬 재시작
sudo service docker restart
-
Docker Hub 푸시 실패
- 문제: 인증 오류로 이미지 푸시 실패
- 해결: Jenkins에서 Docker Hub 자격 증명 재설정
-
컨테이너 포트 매핑 문제
- 문제: 애플리케이션에 접근할 수 없음
- 해결: 컨테이너 재시작 with 올바른 포트 매핑
docker stop spring-app docker rm spring-app docker run -d --name spring-app -p 80:80 chinarong2/spring-app:latest
-
Watchtower 업데이트 감지 실패
- 문제: 새 이미지 푸시 후 자동 업데이트 안 됨
- 해결: Watchtower 로그 확인 및 재시작
docker logs watchtower docker restart watchtower
-
EC2 인스턴스 연결 문제
- 문제: SSH를 통한 EC2 연결 실패
- 해결: 보안 그룹 설정 확인 및 수정 (SSH 포트 22 열기)
-
애플리케이션 로그 확인
- 문제: 애플리케이션 오류 발생
- 해결: 컨테이너 로그 확인
docker logs spring-app
- 🧪 자동화된 테스트 추가
- 📊 모니터링 및 로깅 개선
- 🔐 보안 강화
- 🔧 다중 환경 (개발, 스테이징, 프로덕션) 설정