[ Jenkins ] Jenkins Pipeline을 이용한 CI/CD + SSHAgent

 

[ 1. 글을 작성하는 이유 ] 

프로젝트를 하면서 마지막으로 Jenkins를 이용한 파이프라인 CI/CD를 하면서 너무 많은 오류를 만났습니다. 학습한 내용을 정리하는 시간을 가지게 되었습니다.

이 작성 글에는 중복적인 내용이 있기 때문에 위에 글을 보시면 도움이 됩니다.

 

[ 2. Jenkins Pipeline에 대해서 알아보자 ] 

이번에 진행할 배포는 파이프라인을 이용을 해서 하려고 합니다. 일단 기본적으로 Jenkins 인스턴스와 Workspace 인스턴스를 연결하기 위해 SSH 프로토콜을 사용합니다. 

이후 Jenkins에서 빌드한 jar파일을 Docker에 올려서 Workspace에 실행하는 방식을 사용을 하려고 합니다. 

추가적으로 Git에 Git Webhook을 이용해서 변경된 사항을 파악하여 Jenkins 인스턴스에 push 하게 추가적인 작업을 했습니다.

 

[ 3. Jenkins Pipeline 실행하기]

저희가 이전에 작성한 작성글에 소개를 했던 메모리 Swap , Docker, Jenkins에 대한 설정을 준비를 합니다.

[ Jenkins ] Jenkins Item Freestyle CI/CD 배포

Memory Swap

sudo dd if=/dev/zero of=/swapfile bs=128M count=32

sudo chmod 600 /swapfile

sudo mkswap /swapfile

sudo swapon /swapfile

sudo swapon -s

sudo vi /etc/fstab
--------------------
[ vi에 하단에 추가 ] 
/swapfile swap swap defaults 0 0
----------------------
## 용량 확인
free

 

Docker 설치하기

# 오래된 버전 삭제
sudo apt-get remove docker docker-engine docker.io containerd runc

sudo apt-get update
# repository 설정
sudo apt-get -y install \
    apt-transport-https \
    ca-certificates \
    curl \
    gnupg \
    lsb-release

# Docker의 Official GPG Key 를 등록
curl -fsSL https://download.docker.com/linux/ubuntu/gpg | sudo gpg --dearmor -o /usr/share/keyrings/docker-archive-keyring.gpg

# stable repository 를 등록
echo \
  "deb [arch=amd64 signed-by=/usr/share/keyrings/docker-archive-keyring.gpg] https://download.docker.com/linux/ubuntu \
  $(lsb_release -cs) stable" | sudo tee /etc/apt/sources.list.d/docker.list > /dev/null

sudo apt-get update

# Docker Engine 설치
sudo apt-get -y install docker-ce docker-ce-cli containerd.io

# 설치 완료 확인, 버전 확인
docker --version

# /var/run/docker.sock 접근 권한 허용
sudo chmod 666 /var/run/docker.sock

# docker hub 로그인 id/pw 입력
docker login

 

Docker 이용해서 Jenkins 설치하기

docker run \
  --name jenkins-docker \
  -p 8080:8080 -p 50000:50000 \
  -v /home/jenkins:/var/jenkins_home \
  -v /var/run/docker.sock:/var/run/docker.sock \
  -v /usr/bin/docker:/usr/bin/docker \
  -u root \
  -d \
  jenkins/jenkins:lts
  
 
 # jenkins 컨테이너 접속
docker exec -it [jenkins 컨테이너ID] bin/bash

# jenkins 컨테이너 log 확인
docker logs [jenkins 컨테이너ID]

이후 Jenkins에 들어가서 SSH Private키 설정한 이후 SSH Agent를 설치를 해야 됩니다. 

플러그인 관리 > Avaliable Plugins > SSH Agent Plugin > 설치 후 재 실행 > Installed plugins에 설치가 되었는지 확인한다.

 

그리고 Item에 Pipeline을 이용해서 프로젝트를 생성을 합니다.

이후 Pipeline에 script에 스크립트를 입력을 해줍니다. 저희는 이전의 node 버전이 아닌 stoarge방식을 사용을 합니다.

pipeline {
    agent any
    stages {
       stage('Prepare') {
            steps {
                git branch: 'master',
                    url: 'https://github.com/Side-Challenge-Study-Time/StudyTime_BE.git'
            }
        }
		stage('Build Gradle') {
            steps{
                sh 'chmod +x gradlew'
                sh  './gradlew clean build'

                sh 'ls -al ./build'
            }
        }

		stage('Docker build image') {
            steps{
                sh 'docker build -t kimmugeon/docker-jenkins-github-test .'
            }
        }

		stage('Docker push image') {
            steps{
                sh 'docker login -u {id} -p {password}'
                sh 'docker push kimmugeon/docker-jenkins-github-test'
            }
        }

        stage('Run Container on SSH Dev Server'){
            steps{
                echo 'SSH'
                sshagent (credentials: ['ubuntu-server']) {
					sh "ssh -o StrictHostKeyChecking=no ubuntu@13.209.121.xxx 'whoami'"
                    sh "ssh -o StrictHostKeyChecking=no ubuntu@13.209.121.xxx 'docker ps -q --filter name=docker-jenkins-github-test | grep -q . && docker rm -f \$(docker ps -aq --filter name=docker-jenkins-github-test)'"
                    sh "ssh -o StrictHostKeyChecking=no ubuntu@13.209.121.xxx 'docker rmi -f kimmugeon/docker-jenkins-github-test'"
                    sh "ssh -o StrictHostKeyChecking=no ubuntu@13.209.121.xxx 'docker run -d --name docker-jenkins-github-test -p 8081:8080 kimmugeon/docker-jenkins-github-test'"
                }

            }

        }
    }
}

일단 스크립트에 대해서 간단하게 설명 하겠습니다.

일단 순서로는 Jenkins 인스턴스는 Git Clone > Gradle build > Docker build > Docker push를 진행하며

SSH 인스턴스는 Docker pull > Docker run

1. jenkins인스턴스 git clone
2. jenkins인스턴스 gradle build
3. jenkins인스턴스 docker build
4. jenkins인스턴스 docker push
5. jenkins인스턴스 -> server인스턴스 ssh접속
6. server인스턴스 docker pull
7. server인스턴스 docker run

 

이후 저희는 SSH Agent를 이용해서 Jenkins Credential 설정에서 Secret text를 진행을 하겠습니다.

Pipeline Sytax > Steps > Sample Step > ssgagent: SSH Agent > Add를 추가한다.

이후 Kind에 SSH Username with private key를 선택을 합니다.

 

💣여기서 중요한 부분인 Private Key를 선택을 해야 됩니다. 저희는 AWS에 pem 파일내용을 선택을 합니다.

-----BEGIN RSA PRIVATE KEY----- 

~~~~~ ssh 인스턴스의 pem 파일을 클릭하면 나옵니다

-----END RSA PRIVATE KEY-----

이후 저장을 하고 지금 빌드를 선택을 하면 빌드가 실행이 된다. 

정상적으로 빌드가 된 것을 확인이 가능합니다.

 

[ 4. Git WebHook ]

저희가 연결하고 싶은 Github Repository를 선택을 합니다.

Setting > Webhooks > Add webhook을 선택을 합니다.

GitHub - Side-Challenge-Study-Time/StudyTime_BE: 스터디 타임 프로젝트(Back_End)

여기서 URL은 WorkSpace의 탄력적 IP를 입력하고 포트 및 github-webhook을 입력합니다.

이때 꼭 Json을 선택을 합니다.

http://{탄력적 IP}:8080/github-webhook/

이후 Jenkins에 설정에 Github를 추가적으로 설정하면 성공적으로 활성화됩니다.