[Infra] Docker, Jenkins를 이용하여 MSA 프로젝트 CI/CD 구축하기(3) - Jenkins 파이프라인 구축

이 시리즈에서는 MSA 프로젝트를 생성한 뒤, Docker와 Jenkins를 이용하여 CI/CD를 구축하는 과정을 설명하도록 하겠다.

 

이전 포스팅에서는 Docker를 설치와 수동 배포 과정과 자동 배포의 필요성에 대해 설명했었다. 그리고 Jenkins를 설치하는 방법에 대해서도 설명했다

 

 

 

Docker 설치하기 : https://programmingiraffe.tistory.com/12

[Infra] Docker, Jenkins를 이용하여 MSA 프로젝트 CI/CD 구축하기(1) - Docker 설치

 

Jenkins 설치하기 : https://programmingiraffe.tistory.com/124

[Infra] Docker, Jenkins를 이용하여 MSA 프로젝트 CI/CD 구축하기(2) - Jenkins 설치

 

 

 

 

 

💻 환경

• OS : Window
• Server : AWS EC2
• Backend : Spring boot, Spring Cloud(Gateway, Eureka), Gradle, Java11
• Deploy : Docker, Dockerhub, Jenkins
• Git : Gitlab

 

 

 

 

📐 프로젝트 구조도

 

아키텍처(수정됨)

 

• 백엔드 6개, DB 2개, Jenkins(Docker in docker로 했다) 총 9개의 컨테이너를 만들 것이다.
• 그리고 GitLab과 연결하여 webhook을 설정해 push 이벤트가 발생할 때마다 자동으로 배포가 되도록 할 것이다.
• 각 서비스별로 브랜치를 구성했다. 그래서 각 브랜치 별로 webhook을 설정해야 한다.

 

 

 

 

CI/CD 과정

 

 

 

1. 소스코드가 해당 브랜치에 push 된다. (푸쉬 이벤트 발생)
2. 프로젝트 내의 Jenkinsfile을 읽어 실행한다.
3. Git에 있는 프로젝트를 Clone해, 빌드를 한다.
4. jar 파일이 생성되고, 도커 이미지로 빌드한다.
5. 도커 이미지를 도커 허브에 업로드 한다.
6. 지금 도커에서 run 되고 있는 해당 이미지를 중지하고, 삭제시킨다.
7. 그리고 도커 허브에 있던 새 이미지를 받아 run 한다.
8. Spring 서버가 도커 컨테이너로 AWS에 배포된다.

 

 

 

 

 

---

🤵🏻 Jenkins Pipeline 생성

• 새로운 Item 생성

 

 

 

• 파이프 라인을 생성한다. item 이름은 해당 마이크로 서비스의 이름을 입력했다.

 

 

 

 

 

🤵🏻 Jenkins file 작성

pipeline {
    agent any
    environment {
        DOCKER = 'sudo docker'
    }

    stages {
        stage('Clone Repository') {
            steps {
                checkout scm
                echo 'Checkout Scm'
            }
        }

        stage('Build image') {
            steps {
                sh 'ls -al'
                dir('[디렉토리명]) {
                    sh 'ls -al'
                    sh 'chmod +x ./gradlew'
                    sh './gradlew build'
                    sh 'docker build -t [docker hub 계정]/[docker 이미지 이름] .'
                }
                echo 'Build image...'
            }
        }

        stage('Remove Previous image') {
            steps {
                script {
                    try {
                        h 'docker stop [docker 이미지 이름]'
                        sh 'docker rm [docker 이미지 이름]'
                    } catch (e) {
                        echo 'fail to stop and remove container'
                    }
                }
            }
        }
        stage('Run New image') {
            steps {
                sh 'docker run --name [docker hub 계정]/[docker 이미지 이름] -d -p [포트번호]:[포트번호] [docker hub 계정]/[docker 이미지 이름]'
                echo 'Run New member image'
            }
        }
    }
}

 

 

 

 

 

🤵🏻 SCM 설정

Jenkins script를 작성해서 push 이벤트가 발생할 때 읽도록 할 것이므로 Definition을 Pipeline script에서 Pipeline script from SCM으로 변경한다.

 

그리고 Git과 연동할 것이므로 SCM을 Git으로 선택한다. 그러면 Git 연동을 설정하는 항목들이 추가로 보인다.

 

 

 

Repository URL 입력

Git 프로젝트의 URL을 입력한다.

 

 

 

 

 

🦊 GibLab Access Token 생성

Git 프로젝트의 Access Token 을 생성하지 않았다면 아래와 같이 Failed to connect to repository가 뜬다. GitLab 프로젝트에 가서 Access Token을 설정해줘야 한다.

 

 

 

 

 

 

GitLab 프로젝트에서 Settings > Access Toekn 에 들어가서 토큰을 생성해준다.

(최초 1회만 설정해주면 된다. 이미 토큰을 생성했다면 건너뛰어도 된다.)

 

 

 

 

 

 

🤵🏻 SCM 설정

 

Credientials 설정하기

 

다시 Jenkins의 SCM 설정으로 돌아와서 Credientials에서 내 GitLab 계정과 연동해줘야 한다. 이미 추가를 했다면 내 계정을 선택하면 되지만, 내 계정이 등록되어 있지 않다면 Add > Jenkins를 클릭해 추가해준다.

 

 

 

Username에 내 Gitlab 계정을 입력해주고, Password에 Gitlab 계정 비밀번호를 입력해준다. 그러면 추가가 되고, 추가된 계정을 Credientials로 선택해주면 된다.

 

 

 

 

Branches to Build 설정

webhook을 걸 branch를 입력해준다.

 

 

 

 

Script Path 입력하기

Repository 내에서 Jenkinsfile이 위치한 경로를 입력해준다.

 

 

 

 

 

 

🤵🏻 Jenkins에서 Webhook 설정

GitLab Plugin 설치

Dashboard > Jenkins 관리 > Plugin 관리 > Available Plugin에 들어간다.

검색창에 gitlab을 검색해 아래 나오는 플러그인을 설치해주면 된다.

 

 

 

 

 

 

 

Build Trigger 설정

다시 Jenkins pipeline을 설정하는 부분으로 돌아와서 Build Trigger를 설정해준다.

 

Build when a change is pushed to GitLab 클릭

(이때, 체크하면 나오는 URL을 복사한다. GitLab으로 가서 Webhook을 연결할 때 쓰인다.)

 

 

 

 

 

 

 

 

 

Secret token 생성하기

고급 > Secret token > Generate 을 클릭한다. (Secret token 복사해둔다. GitLab으로 가서 Webhook을 연결할 때 쓰인다.)

 

 

 

 

 

 

 

🦊 GibLab에서 Webhook 설정

 

프로젝트 > Settings > Webhooks 로 들어간다. 아래 사항을 입력하고 Add webhook을 한다.

 

• URL : 이전에 Jenkins에서 Build Trigger을 클릭했을 때 옆에 나온 URL 입력
• Secret token : 고급 > Secret token > Generate 했을 때 나온 token 입력
• Trigger : Webhook Trigger를 걸 브랜치를 입력한다.

 

 

 

 

 

 

 

😎 결과

GibLab Webhook

프로젝트에 설정된 Webhook을 볼 수 있다. Test를 통해 직접 Push 이벤트를 줄 수도 있다.

 

 

 

 

 

Jenkins 파이프라인 별 CI/CD 성공 확인

 

 

 

 

 

파이프라인에서 CI/CD Stage 확인

 

 

 

 

 

Docker 컨테이너 확인

현재 배포중인 서비스를 확인할 수 있다.

docker ps