SampleController : 간단한 테스트를 하기 위한 컨트롤러
Dockerfile : 도커파일
deploy.sh : 배포용 스크립트
HealthController
@RestController
public class SampleController {
@RequestMapping("/sample")
public String sample() {
return "checkcheck";
}
}
Dockerfile
# Amazon JDK11 사용
FROM amazoncorretto:11
# JAR_FILE 변수에 값을 저장
ARG JAR_FILE=build/libs/*.jar
# 변수에 저장된 것을 컨테이너 실행시 이름을 app.jar파일로 변경하여 컨테이너에 저장
COPY ${JAR_FILE} app.jar
# 빌드된 이미지가 run될 때 실행할 명령어
ENTRYPOINT ["java","-jar","/app.jar"]
deploy.sh
# docker를 시작하기 위함
sudo systemctl start docker
# 가동중인 mkc 도커 중단 및 삭제
docker ps -a -q --filter "name=mkc" | grep -q . && docker stop mkc && docker rm mkc | true
# 기존 이미지 삭제
docker rmi taeyun1215/mkc
# 도커허브 이미지 pull
docker pull taeyun1215/mkc
# 도커 run
docker run -d -p 8080:8080 --name mkc taeyun1215/mkc
# 사용하지 않는 불필요한 이미지 삭제 -> 현재 컨테이너가 물고 있는 이미지는 삭제되지 않습니다.
docker rmi -f $(docker images -f "dangling=true" -q) || true
EC2 만들기는 밑에 페이지에 시작부분을 참고하여 만들면 된다.
나는 이름 및 태그를 study-cicd-docker로 두었다.
탄력적 IP를 할당하는 이유는?
EC2 메인페이지에 왼쪽 탭에 네트워크 및 보안 → 탄력적 IP → 탄력적 IP 주소 할당을 클릭한다.
우리는 운영 EC2, jenkins EC2 두개 이므로 탄력적 IP를 두개 생성해준다.
탄력적 IP를 기존에 만들어 두었던 두개 EC2에 연결하면 된다. → 탄력적 IP 주소 연결을 클릭한다.
탄력적 IP 1개는 운영용 EC2, 나머지 탄력적 IP는 jenkins EC2로 매칭해서 연결한다.
연결된 탄력적 IP는 EC2 메인페이지에서 확인이 가능하다.
# 운영 EC2 접속
ssh 호스트명
# 패키지 업데이트
sudo yum -y upgrade
# 도커 설치
sudo yum -y install docker
# 도커 설치 작업이 잘 되었는지 버전 확인
docker -v
# 도커 시작
sudo service docker start
# 도커 그룹에 사용자 추가 -> docker가 그룹명, ec2-user가 사용자명
sudo usermod -aG docker ec2-user
jenkins EC2 세팅하기 전 시나리오를 알고 있어야한다.
Jenkins EC2에 도커를 설치한다.
# 운영 EC2 접속
ssh 호스트명
# 패키지 업데이트
sudo yum -y upgrade
# 도커 설치
sudo yum -y install docker
# 도커 설치 작업이 잘 되었는지 버전 확인
docker -v
# 도커 시작
sudo service docker start
# 도커 그룹에 사용자 추가 -> docker가 그룹명, ec2-user가 사용자명
sudo usermod -aG docker ec2-user
Dockerfile 생성 및 코드 작성
# Dockerfile 생성
sudo vim Dockerfile
# Dockerfile 작성 시작
FROM jenkins/jenkins:jdk11
# 도커를 실행하기 위한 root 계정으로 전환
USER root
# 도커 설치
COPY docker_install.sh /docker_install.sh
RUN chmod +x /docker_install.sh
RUN /docker_install.sh
# 도커 그룹에 사용자 추가
RUN usermod -aG docker jenkins
USER jenkins
docker_install 생성 및 코드 작성
# docker_install.sh 파일 생성
sudo vim docker_install.sh
# docker_install.sh 파일 작성 시작
# !/bin/sh
apt-get update && \
apt-get -y install apt-transport-https \
ca-certificates \
curl \
gnupg2 \
zip \
unzip \
software-properties-common && \
curl -fsSL https://download.docker.com/linux/$(. /etc/os-release; echo "$ID")/gpg > /tmp/dkey; apt-key add /tmp/dkey && \
add-apt-repository \
"deb [arch=amd64] https://download.docker.com/linux/$(. /etc/os-release; echo "$ID") \
$(lsb_release -cs) \
stable" && \
apt-get update && \
apt-get -y install docker-ce
2, 3번 파일인 Dockerfile, docker_install은 동일한 디렉토리에 두고 빌드해야하며 docker.sock 권한을 변경해줘야한다.
sudo chmod 666 /var/run/docker.sock
Dockerfile을 빌드하여 이미지 생성한다.
docker build -t jenkins .
해당 폴더를 만드는 이유는 아직 잘 모르겠다..todo
# jenkins 폴더 만들기
mkdir jenkins
# 해당 폴더에 대해 권한 부여하기
sudo chown -R 1000 ./jenkins
이제 jenkins 컨테이너를 띄운다.
sudo docker run -d --name jenkins \
-v /home/ec2-user/jenkins:/var/jenkins_home \
-v /var/run/docker.sock:/var/run/docker.sock \
-p 8085:8080 \
-e TZ=Asia/Seoul \
jenkins
EC2에서 설정해준 탄력적 IP가 필요하다.
접속을 하면 비밀번호를 입력하라는 페이지가 나온다.
jenkins에 접속을 했다면 jenkins 관리 → System Configuration → ****플러그인 관리 → install plugins에 플러그인을 검색하여 설치해준다.
jenkins 관리 → Security -> Manage Credentials를 클릭하여 jenkins에서 사용할 계정 정보들을 등록한다. 지금 하고 있는 Architecture에서는 Github와 Docker의 계정 등록이 필요하다.
Github → Setting → Developer setting → Personal access tokens으로 들어가서 Generate new token을 클릭후 token을 생성해준다. 밑은 권한 설정이다.
Jenkins와 Web hook으로 연결하고 싶은 프로젝트로 들어가서 오른쪽에 Settings를 클릭합니다.
왼쪽 탭에 Webhooks를 클릭한다.
jenkins(main page) → jenkins 관리 → 시스템 설정을 클릭한다.
Github 관련 세팅을 한다.
Add를 클릭해서 나온 Add credential 페이지를 작성하면 된다.
Test connection을 하면 연결이 됐는지 확인이 된다.
방금 페이지에서 제일 아래로 내리면 SSH Servers를 설정할 수 있는 부분이 나올 것이다.
고급을 클릭하여 들어가면 key 값을 입력해야하는데 이것은 앞전에 받아온 pem 키값이다.
Jenkins EC2에서 운영 EC2를 접속하는 것이기에 운영 EC2에 Jenkins EC2 보안 권한을 추가해줘야한다.
AWS EC2 메인페이제에서 운영 EC2에 클릭하고 보안 탭을 클릭한다.
보안 → 보안 그룹에 존재한 그룹 클릭 → 인바운드 규칙 → 인바운드 규칙 편집을 클릭한다.
규칙 추가 → SSH, IP(jenkins EC2 탄력적 IP)로 등록한다.
위 운영 EC2와 똑같은 작업으로 Jenkins EC2 → 보안그룹 → 인바운드 규칙 편집을 클릭힌다.
사용자 지정 TCP, 8080, 해당 IP는 고정된 IP(web hook IP)이다.
여기까지 끝났다면 방금전에 작성하던 Jenkins ssh 설정 페이지에서 Test Configuration을 클릭하여 연결을 확인한다.
하단에 저장버튼클 클릭합니다.
jenkins 메인페이지 → jenkins 관리 → Global Tool Configuration
jenkins 메인페이지 → 새로운 item → awstest (프로젝트 명) → Freestyle project으로 생성.
GitHub project를 선택하고 project url에 본인의 프로젝트 주소를 입력한다.
Git을 선택하고 밑과 같이 작성한다.
빌드 유발은 GitHub hook trigger for GITScm polling만 체크한다.
빌드 환경에서 Use secret text or file을 선택하고 Bindings의 Add 드롭박스를 클릭하고 Username and password (separated)를 선택한다.
각각 Variable에 Username으로 사용할 변수명, Password로 사용할 변수명을 지정해주고 Credentials에 specific credentials을 선택하고 전에 만들어놓았던 Dockerhub 계정을 선택합니다.
Build에서 Invoke Gradle script를 선택한다.
Add build step에서 Execute shell을 선택합니다.
# 도커파일 이미지를 빌드합니다.
docker build --build-arg DEPENDENCY=build/dependency -t taeyun1215/mkc --platform linux/amd64 .
# 도커 로그인을 시도합니다. $변수명 을 이용하면 위에서 작성한 변수명으로 값을 사용할 수 있습니다.
echo $PASSWORD | docker login -u $USERNAME --password-stdin
# 도커허브에 빌드된 이미지를 푸시합니다.
docker push taeyun1215/mkc
# 푸시한 이미지를 삭제합니다.
docker rmi taeyun1215/mkc
# 참고
# taeyun1215/mkc -> 도커 계정 ID/도커 레파지토리 명으로 두면 된다.
# 위 부분은 처음에 작성한 script/depoly.sh에서 사용할 명이니 참고해야한다.
여기까지가 코드를 빌드, 테스트하고 이미지를 빌드하여 도커허브에 푸시하는 작업이다.
이 밑 부터는 Jenkins EC2에서 운영용 EC2로 접속하는 작업이다.
빌드 후 조치를 선택하고 send build artifacts over SSH를 선택합니다.
send build artifacts over SSH에 운영용 EC2를 설정하면 된다.
# 운영용 EC2에서 도커에 로그인을 합니다.
echo $PASSWORD | docker login -u $USERNAME --password-stdin
# deploy.sh 파일을 실행합니다.
sh deploy.sh
최종적으로 작업이 끝난 후 workspace를 비우도록 합니다.
맨 아래 저장버튼을 클릭한다. 그럼 이제 Github에 지정한 브랜치에 푸시하면 자동으로 빌드 및 배포까지 가능하게 된다.