Jenkins로 무중단 배포 파이프라인 구축하기

프로젝트를 AWS EC2 인스턴스에 Jenkins를 사용하여 자동 배포하는 과정
로컬 코드 변경 → 깃허브 푸시 → 젠킨스에서 이를 감지 → 자동으로 도커이미지로 빌드 및 ec2 서버에서 풀 받아서 배포

해당 과정에서 ec2 인스턴스와 도커는 설치되어있다고 가정하고, 젠킨스 서버와 배포 서버를 따로 둬서 진행한다. 도커는 두 인스턴스에 모두 설치되어 있어야 한다.

 

배포 과정에서 Docker의 역할

• 이미지 빌드 → 젠킨스 서버에서 소스코드로부터 도커 이미지를 빌드한다.
• 이미지 저장 → 빌드된 도커 이미지는 Docker Registry(ex. Docker Hub, AWS ECR 등)에 푸시된다. 이 과정은 젠킨스에서 자동화할 수 있다.
• 이미지 배포 및 실행 → 배포 대상 인스턴스에서 Docker 이미지를 레지스트리로부터 풀 받은 후, 컨테이너로 실행한다. 이 단계에서 배포 서버에도 도커가 설치되어 있어야 한다.⇒ 도커는 애플리케이션과 그 종속성을 컨테이너 내에 패키징하여 어떤 환경에서도 동일하게 실행될 수 있도록 한다. 이는 개발, 테스트, 프로덕션 환경 간의 일관성을 보장하는 데 필수적이다.
• ⇒ 도커 이미지는 도커 엔진 위에서 컨테이너로 실행되기 때문에 이미지를 컨테이너로 실행하기 위해서는 배포 서버에 도커가 설치되어 있어야 한다.

ec2 인스턴스 용량 확대

참고) https://velog.io/@kku64r/ec2freetier

https://velog.io/@kmw10693/EC2-프리티어-용량-늘리기

https://yunamom.tistory.com/302

 

EC2 인스턴스에 Jenkins 설치

sudo yum update -y

 

🫥  apt-get이 작동하지 않고 yum이 작동하는 이유

ec2를 만들 때 Amazon Linux를 사용했기 때문

Amazon Linux는 Red Hat Enterprise Linux와 CentOS에 기반을 둔 리눅스 배포판이다. apt-get은 데비안 기반의 리눅스 배포판에서 사용하는 패키지 관리 도구이다.

 

ec2 서버 안에 직접 Jenkins를 설치하는 경우

sudo wget -O /etc/yum.repos.d/jenkins.repo \\
    <https://pkg.jenkins.io/redhat-stable/jenkins.repo>

sudo rpm --import <https://pkg.jenkins.io/redhat-stable/jenkins.io-2023.key>

sudo yum upgrade

 

Install Java (Amazon Linux 2023)

sudo dnf install java-11-amazon-corretto -y

젠킨스는 자바 기반 애플리케이션이라 젠킨스를 설치하기 전에 자바ㅏ가 설치되어잇어야함

 

Install Jenkins

sudo yum install jenkins -y

sudo systemctl enable jenkins
sudo systemctl start jenkins

 

젠킨스 웹브라우저 접속

https://guide-gov.ncloud-docs.com/docs/devtools-devtools-1-2 참고

웹브라우저 열고 http://ec2인스턴스의퍼블릭ip:18080/ 에 접속하면 된다.

(ec2 보안그룹에서 18080포트가 추가되어 있어야 함)

 

패스워드 확인하기

sudo cat /var/lib/jenkins/secrets/initialAdminPassword

 

도커허브에서 젠킨스 다운받기

https://bsssss.tistory.com/1176 참고

sudo docker run -itd --name jenkins  -v /var/run/docker.sock:/var/run/docker.sock -v /usr/bin/docker:/usr/bin/docker -p 18080:8080 jenkins/jenkins:lts

 

비밀번호 확인

docker exec jenkins cat /var/jenkins_home/secrets/initialAdminPassword

 

Jenkins - Github 계정 연동 설정

이 과정을 통해 깃허브에서 발생하는 이벤트(ex. 코드 푸시)가 Jenkins에서 자동으로 빌드를 트리거할 수 있게 된다.

 

1. Github Personal Access Token 생성

github -> settings -> developer settings -> Personal access tokens

해당 페이지에서 Generate new token 클릭 token 이름 설정 후 repo, admin_hook 권한을 체크하고 Generate token 을 클릭한다.

 

2. 토큰 연동 - 젠킨스에 Github Credentials 추가

젠킨스 대시보드에서 Manage Jenkins → Credentials로 이동한다.

Jenkins 스코프 내에서 global 영역을 선택하고 Add Credentials를 클릭한다.

Kind에서 Username with password를 선택하고 Username에는 내 깃허브 아이디를, 앞서 생성한 Github Personal Access Token을 Password 필드에 입력한다. ID와 Description을 적절히 설정하여 토큰을 식별할 수 있게 한다.

OK를 클릭하여 저장한다.

 

3. 깃허브 서버 연동

젠킨스 대시보드에서 Manage Jenkins → System으로 이동한다.

내리다 보면 Github라는 게 있는데 거기에 name을 임의로 지정 후 Credentials에서 Add → Jenkins를 클릭해준다.

credential을 등록한다. (Kind를 Secret text로, Secret에는 깃허브 토큰을)

test connection을 눌렀을 때 내 깃허브 아이디와 연동되면 성공!

 

4. Github 웹훅 설정

깃허브에서 젠킨스와 연동할 레포지토리로 이동한다.

Settings → Webhooks로 이동하여 Add webhook을 클릭한다.

Payload URL에 젠킨스 서버의 url을 입력한다. 일반적으로 이 url은 http://your-jenkins-url/github-webhook/ 형식이다.

Content type을 application/json으로 선택한다.

"Which events would you like to trigger this webhook?"에서 "Just the push event."를 선택하거나, 필요에 따라 다른 이벤트를 선택할 수 있습니다.

"Active"를 체크하고 "Add webhook"을 클릭합니다.

 

Jenkins에서 GitHub 프로젝트 설정

1. Jenkins에서 새로운 "Pipeline"을 생성한다.
2. "General" 섹션에서 "Github project"을 선택하고, GitHub 리포지토리의 URL을 입력한다.
3. "Build Triggers" 섹션에서 "GitHub hook trigger for GITScm polling"을 선택한다.
4. 필요한 빌드 스크립트를 구성한다.

이렇게 설정하면 GitHub에 코드가 푸시될 때마다 Jenkins가 자동으로 빌드를 시작하도록 설정할 수 있다.

 

Docker Registry 인증 정보 등록

docker pipeline plugin 설치

Jenkins Management → Credentials → Add Credentials → username: dockerhub id , password: dockerhub password

 

ssh agent 설치

젠킨스 배포 스크립트에서 ssh를 통해 ec2 인스턴스에 접근해야 한다. 따라서 ssh agent 플러그인을 설치해야 한다.

Credentials 추가

나는 ubuntu를 안썻기 때문에 username에 ec2-user를 썼다.

 

https://cl8d.tistory.com/m/95 참고

 

젠킨스 스크립트 작성

이제 대망의 젠킨스 스크립트 작성만 남았다.

pipeline {
    agent any

    environment {
        // 환경 변수 설정
        DOCKER_IMAGE = 'dockerhub-username/projectname'
        DOCKER_TAG = 'latest'
        CONTAINER_NAME = 'projectname'
        EC2_HOSTNAME = 'ec2서버주소'
    }

    stages {
        stage('Checkout') {
            steps {
                // GitHub 메인 브랜치에서 소스 코드 체크아웃
                git branch: 'main', url: '<https://github.com/projectname.git>'
            }
        }

        stage('Build & Push Docker Images') {
            steps {
                script {
                    // Docker Hub에 로그인
                    withCredentials([usernamePassword(credentialsId: 'docker-credentials', usernameVariable: 'DOCKER_USERNAME', passwordVariable: 'DOCKER_PASSWORD')]) {
                        sh 'echo $DOCKER_PASSWORD | docker login -u $DOCKER_USERNAME --password-stdin'
                    }
                    // Docker 이미지 빌드 및 푸시
                    sh 'docker build -t $DOCKER_IMAGE:$DOCKER_TAG ./'
                    sh 'docker push $DOCKER_IMAGE:$DOCKER_TAG'
                }
            }
        }

        stage('Deploy to EC2') {
            steps {
                // Docker 이미지를 실행하기 위해 SSH 에이전트를 사용합니다.
                sshagent(credentials: ['ssh-credentials']) {
                    // SSH를 통해 EC2 인스턴스에 접속하여 Docker 이미지 실행
                    sh """
                        ssh -o StrictHostKeyChecking=no ec2-user@$EC2_HOSTNAME '
                            docker pull $DOCKER_IMAGE:$DOCKER_TAG
                            docker stop $CONTAINER_NAME || true
                            docker rm $CONTAINER_NAME || true
                            docker run -d --name $CONTAINER_NAME -p 80:80 $DOCKER_IMAGE:$DOCKER_TAG
                        '
                    """
                }
            }
        }
    }
}

 

마지막에러..ㅠㅠㅠㅠ

ERROR: Failed to find configuration named [ssh-credentials] check the global configuration

이것만 해결하니 성공했다..

하

에러 진짜많이났다

ec2 hostname을 54-180-80-81로 해서도 났고

용량 다차서 rmi를 안해서도 낫고..

ssh 키에 %가 들어가서도 났고..

 

트러블슈팅ㅇ은 추후에 정리해보고자 한다.