[ Jenkins ] Jenkins Item Freestyle CI/CD 배포

1. 서론

---

안녕하세요. 이번에는 AWS EC2에서 Jenkins Item에 FreeStyle 배포에 대해서 학습한 내용을 정리하기 위해 글을 작성을 했습니다. 배포를 크게 2개로 나누어 Github를 사용하지 않는 방식과 사용하는 방식으로 정리를 하겠습니다.

혹시 Jenkins에 대해서 처음 학습을 하신다면 기존에 정리한 Jenkins에 대해서 한번 보시는걸 추천을 합니다.

[ Jenkins ] Jenkins CI/CD 무엇인가?

 

2. 본론

---

일단 하나의 간단한 프로젝트를 만들어서 배포를 해보겠습니다.

GitHub - KMGeon/DeployAWS: Jenkins CI/CD 연습 & Git Squash Merge 연습

일단 실습을 하기 위해 Dockerfile을 만들겠습니다.

FROM openjdk:11-jdk
ARG JAR_FILE=build/libs/*.jar
COPY ${JAR_FILE} app.jar
ENTRYPOINT ["java","-jar","/app.jar"]

 

AWS EC2에 접속하기

---

[ AWS ] AWS랑 친해지기-1 (AWS EC2 기본 배포)

 

[ AWS ] AWS랑 친해지기 -2 (시간 설정)

 

[ AWS ] AWS랑 친해지기 - 3 (Docker를 이용해서 배포하기)

 

AWS EC2 인스턴스 메모리 부족 해결을 위해 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

이렇게 free를 입력하면 정상적으로 swap이 성공적으로 수행이 되었습니다.

 

AWS EC2(ubuntu 20.04)에 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 login은 docker hub에 아이디와 비밀번호를 입력을 해주면 됩니다.

정상적으로 로그인이 되었다면 Login Success가 동작을 하게 됩니다.

이후 Jenkins docker로 설치를 하겠습니다.

 

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 컨테이너 ID를 찾기 위해서는 docker ps -a를 입력해서 아이디를 찾을 수 있습니다.

 

AWS EC2 인바운드 규칙 추가

---

Jenkins의 기본적인 포트는 8080입니다.

그래서 저희는 8080포트를 허용을 해야지 젠킨스를 사용할 수 있습니다. 그러기 위해 인바운드 규칙을 추가를 하겠습니다.

무료 클라우드 컴퓨팅 서비스 - AWS 프리 티어

 

1. aws에 접속하여 ec2에 접속을 합니다.

2. 이후 보안을 클릭하여 보안 그룹에 밑에 sg-xxxx에 접속을 합니다.

3. 인바운드 규칙 편집을 하여 규칙 추가를 통해 8080 포트를 추가합니다.

 

Jenkins 접속하기

---

인바운드 규칙을 추가하면 { 탄력적 IP } : 8080 주소를 통하여 Jenkins에 접속이 가능합니다.

이때 비밀번호를 입력을 해야되는데 이 경우에 기본적으로 설정된 비밀번호를 입력을 해야됩니다.

그러면 docker의 명령어를 통해 비밀번호를 찾아보겠습니다.

# docker 이미지로 배포시 확인
docker exec jenkins-docker cat /var/jenkins_home/secrets/initialAdminPassword

 

이후 패스워드 입력하면 Jenkins Plugins Install화면이 나옵니다. 이때 Install suggested Plugins를 입력을 합니다.

만약에 비밀번호를 설정을 했으면 다음에는 다음과 같은 화면이 나옵니다.

 

Public-over-ssh 설치하기

---

여기까지 성공을 했다면 public-over-ssh를 수동으로 설치를 해야됩니다.

Index of /plugins/publish-over-ssh/latest

이후 Jenkins관리 - Plugin Manager - Advanced settings - Deploy Plugin에 설치한 파일을 추가하여 submit을 합니다.

 

이후 제출을 누르게 되면 public-over-ssh가 기본적으로 준비로 나옵니다. 이때 완료가 되면

다시 Jenkins 관리를 찾으면 됩니다.

 

(중요) - 공개키 & 개인키 생성하여 연결하기

---

기존의 Dashboard > Jenkins 관리 > Configure System을 들어가면 publish over SSH가 있습니다.

저는 기존에 세팅을 하였기 때문에 동작에 관해서만 설명을 하겠습니다.

일단 이 부분이 제일 중요합니다. 젠킨스의 개인키와 공개키를 생성을 해야되는데

일단 설명을 하기 이전에 잠깐 설명을 하겠습니다.

저희는 EC2를 2개를 사용합니다. 하나는 Jenkins 인스턴스와 Work 인스턴스 2개가 있습니다. 저희는 ssh를 통해 설정을 해야지 가능합니다.

SSH(Secure Shell)

ssh는 네트워크를 통해 안전하게 데이터를 전송하기 위한 프로토콜입니다. 암호화(RSA)기술을 사용하여 데이터를 안전하게 전송하며, 데이터의 무결성과 기밀성을 보장합니다. SSH를 사용하면 인터넷을 통해 전송되는 동안 중간에서 탈취되거나 변경 되는 것을 방지할 수 있습니다.

저희는 EC2 인스턴스에 접속하면 암호화된 터널을 통해 안전하게 데이터를 전송하기 위해 설정을 해야됩니다. 저희는 SSH연결을 하여 Jenkins 인스턴스에서 docker hub를 통해 만든 이미지를 Work 인스턴스에 배포하는 형태로 배포를 합니다.

다음과 같은 명령어를 통해 개인키와 공개키를 생성한다. 이를 work 인스턴스에 ssh-server에 등록을 해야된다.

ssh-keygen -t rsa -b 4096 -m PEM

그러면 다음과 같은 화면이 나왔다면 성공적으로 생성이 되었습니다. 

이후 개인키를 확인을 하기 위해 다음과 같은 명령어를 입력을 합니다.

cd /root/.ssh

cat id_rsa.pub

 

Jenkins 공개키 Work 인스턴스에 등록하기

일단 기존에 만들었던 Work 인스턴스에 접속을 하여 기존에 작업을 했던 것을 합니다.

일단 docker에 대한 설치와 로그인을 합니다.

그리고 이제 공개키를 등록을 하겠습니다.

# worker-instacne에서 ~/.ssh 권한설정
chmod 700 ~/.ssh
chmod 600 ~/.ssh/authorized_keys

# jenkins-instance의 공개키를 worker-instance 인증키에 등록
vi ~/.ssh/authorized_keys

 

저희가 Jenkins 인스턴스에 찾은 값을 vi를 통해 work 인스턴스에 추가하는 방식입니다.  젠킨스에 찾은 내용을 아래에 추가하는 방식입니다.

만약에 VI에 대해서 처음 학습을 하시면 이전에 작성한 글을 참고를 해주세요.

[Linux] 리눅스에 대해 알아보자 + 기본 명령어

일단 여기서는 I를 입력하면 Insert 모드가 되고 값을 입력하고 ESC을 하고 :WQ을 입력하면 입력된 내용을 저장을 합니다.

 

Jenkins 개인키를 Jenkins 사이트 publish-over-ssh에 등록하기

 cat ~/.ssh/id_rsa

명령어를 입력하면 다음과 같은 값이 나온다. 일단 여기서 중요한 부분은 위에

start, end 부분도 필수적으로 입력을 해야된다. 이 부분을 추가하지 않아서 5시간을 낭비했다.

이후 공개키를 Jenkins 사이트에 추가를 한다.

이때 SSH Servers의 등록할 각 4개의 정보가 있다.

Name	본인이 사용할 임의의 SSH 서버의 이름을 입력한다.
Hostname	실제로 접속할 원격 서버를 입력한다.
Username	접속할 원격 서버의 이름 - whoami를 통해 확인 가능
Remote Directory	원격서버에서 접속하여 작업을 하게 되는 디렉토리 pwd 확인

 

DockerHub 이미지 등록하기

---

 

Docker Hub Container Image Library | App Containerization

도커 허브에 이미지를 등록을 한다.

이전에 만들었던 docker image를 push 하고 등록이 성공적으로 되었는지 확인한다.

docker push mooh2jj/cpu-bound-application-1

 

 

Jenkins Item FreeStyle Project

---

프리스타일 프로젝트를 통하여 생성을 한다. 

이후 빌드 후 조치 > Send build artifacts over SSH를 입력하면 다음과 같은 화면이 나온다.

여기서 Exec command를 추가로 입력을 한다.

nohup docker run -p 8081:8080 kimmugeon/cpu-bound-applicatoin-1:tag > /dev/null 2>&1 &
이때 tag가 중요합니다. 이 부분에서 많은 실수를 했습니다.

이때 8081은 Work 인스턴스의 포트이다. 이 경우에도 위에서 했던 인바운드 규칙 설정을 해야된다. 

이후 빌드를 하고 Console Output을 하면 성공적으로 출력이 된다. 이후 Work 인스턴스의 탄력적 IP를 이용하여 확인을 하면 정상적으로 출력이 된다.

이후 성공적인 로직이 동작한다.

 

이후 추가적인 log 확인하기

---

# 꼬리부터 보는 명령어
# docker contrainer에서 확인시, docker exec 명령어로 들어가야 한다.
cd ~
tail -f nohup.out

 

추가

---

 

Jeinkins/Docker 명령어로 FreeStyle publish-over-ssh 배포하기

Jenkins를 활용한 SpringBoot gradle 빌드&배포

Docker/Jenkins를 활용한 웹서버 자동 배포 & Docker Image 자동 배포