Github Action - CI/CD

CI/CD 이론

CI (Continuous Integration)

CI란?

• Continuous Integration, 지속적인 통합

• 새로운 코드 변경 사항이 정기적으로 빌드 및 테스트되어 공유 레파지토리에 통합하는 것

CI가 필요한 환경 조건

• 다수의 개발자가 형상관리 툴을 공유하여 사용하는 환경

• MSA(Micro Service Architecture) 환경

CI 핵심 목표

• 버그를 신속하게 찾아 해결

• 소프트웨어의 품질 개선

• 새로운 업데이트의 검증 및 릴리즈의 시간 단축

CD (Continuous Deployment)

CD란?

• Continuous Delivery는 공유 레파지토리로 자동으로 Release 하는 것

• Continuous Deployment는 프로덕션 레벨까지 자동으로 deploy 하는 것

• 개발자의 변경 사항이 레파지토리를 넘어, 고객의 프로덕션 환경까지 릴리즈 되는 것

CD 장점

• Agile 방법론의 경우… 서비스의 사용자는 최대한 빠른 시간 내에 최신 버전의 Production을 제공받을 필요가 있는데, 이 때, 소프트웨어가 언제든지 신뢰 가능한 수준의 버전을 유지할 수 있도록 support 하는 목표!

• 서비스의 개발팀과 비지니스팀(영업, CS팀 등) 간의 커뮤니케이션 부족 문제를 해결, 배포에 이르기까지의 노력을 최소한으로 단축시켜 준다는 Benefit을 제공

CI/CD 툴

• Jenkins

• Travis CI

• Bamboo

AWS - EC2, S3, IAM

🔖 진행 순서

1. 보안 그룹 생성

2. EC2 인스턴스 생성

3. IAM 생성

4. S3 Bucket 생성

보안 그룹 생성

• default-ec2-server 라는 이름으로 보안 그룹 이름을 설정함

• 인바운드 규칙에 추가를 한다.



• ✨ SSH
• 전체 오픈을 하거나 pem 키가 노출 되는 경우, 어느 순간부터 서버로 코인이 채굴되고 있을듯…
이를 위해서 보안이 필요하고 pem 키 관리와 지정된 IP에서 SSH 접속이 되도록 구성하는 걸 추천
• 보안을 위해 내 IP로 설정했습니다.
• 8080, HTTPS
테스트를 위해 위의 2개는 전체 오픈을 합니다.

• 나머지는 기본 값으로 저장하면 끗.

EC2 인스턴스 생성

• 이름 : 웹 서버 이름을 설정해주세요.

• 앱 및 OS 이미지 선택

• 인스턴스 유형 설정

• 키 페어(로그인) 설정 → 만들어놓은 키가 없다면 키 페어 생성하기!

• 스토리지 구성 → 프리티어 최대치인 30GB 설정하기

• 보안 그룹 적용!!!
기존 보안 그룹 선택으로 위에서 만든 보안 그룹으로 설정합니다

• 나머지는 기본 설정으로 저장하면 끗.

EIP 설정

• 탄력적 IP 선택 후 탄력적 IP 주소 할당을 클릭합니다.

• 네트워크 경계 그룹만 EC2에 맞춰서 설정을 해주고 할당을 클릭해서 생성합니다.

• 생성된 EIP 선택 후에 작업 탭에서 탄력적 IP 주소 연결 클릭

• 이제 생성된 EC2 인스턴스로 연결시켜줍니다.

• 끗.



인스턴스 PUBLIC IP 주소가 EIP로 설정된 것을 확인 할 수 있습니다.

🍯 EC2 설정

• hello-cicd-server : 서비스명

⁉️ 초기 설치를 위한 툴 설치하기

⁉️ EC2에 Java 설치하기…

• JDK 17 설치

• 나머지 버전은 알아서 추가해주세요… 🫠

IAM 설정

• IAM으로 와서 사용자 추가를 클릭합니다.

• 사용자 이름 등록 하고, 액세스 유형은 프로그래밍 방식 액세스를 선택합니다.

• 기존 정책 직접 연결을 선택

• S3와 CodeDeploy 권한을 추가

• 태그에 이름만 추가를 해주고…

• 마지막으로 확인하고 사용자를 추가합니다.

• ✨ 해당 사용자의 정보는 어딘가에 안전하게 보관해주세요. → Github Action 에서 액세스 키와 비밀키를 등록해줘야 합니다.

S3 버킷 생성

• AWS의 S3 서비스는 파일 서버

• Build 파일을 저장하는 용도로 사용

• CodeDeploy에서 배포할 파일로 가져가도록 구성

가즈아..

• 버킷명 설정

• IAM 키로 접속할 예정이기 때문에 모든 퍼블릭 액세스를 차단시켜 줍니다.

• 저장하면 끗.



 

CI/CD - GIT Action 편

1. 프로젝트 빌드

Github Action 설정

• 가는 길…

• 여기서 이제 파일명 설정을 하고 내용을 작성하면 됩니다.

• 🐶 작성을 해보면..?
🚨
작성 전 주의점 yaml 파일 작성 때, 들여쓰기 안맞거나 오타나는 부분을 조심해주세요!

• 작성을 하고 Commit을 하면 workflows 폴더가 생성되고, 안에 작성된 파일이 생성됩니다.

• 지금까지 작성된 부분까지 잘 작동하는지 먼저 확인해주세요. (이제부터 Action 들은 여기서 확인 가능 합니다.)



 
빌드까지 성공된 것을 확인할 수 있습니다.

소소한 팁

• 실패한 Action도 재 실행 가능합니다. (요인이 외부 요인(AWS 설정 등) 이라면 재실행 해볼만 하겠죠?)

• 그리고 위 사진의 deploy.yml 안에 있는 build를 클릭하면…?



(어느 Step 에서 실패 했는지 오류 내역까지 확인 가능합니다.)

S3 Upload 설정

• deploy.yml → 설정 추가

Upload to S3 마지막 부분 s3://$S3_BUCKET_NAME/$PROJECT_NAME/$GITHUB_SHA.zip

• s3://$S3_BUCKET_NAME : 버킷 이름 빼먹으면 안됩니다… 🫠 (이거 못찾아서 3시간 날림)
• /$PROJECT_NAME : 음.. 프로젝트 이름으로 폴더 경로를 하나 더 만든건데… 생략 하셔도 무방!
• /$GITHUB_SHA.zip : 해당 파일 이름으로 저장됩니다. (Hash 값이니 중복되지 않겠죠?)

• S3 - Upload 구현을 위해 Github Action 키 값 지정



 
위에서 생성한 IAM 키값들을 여기에 등록해줍니다.



• AWS_ACCESS_KEY_ID : IAM 사용자 액세스 키 ID
• AWS_SECRET_ACCESS_KEY : IAM 사용자 Secret 액세스 키

• 그라믄.. 이제 이것도 되는지 확인해 봐야겠쥬?



 
현재 시각.. 7월 14일(목) 오후 3시 48분..



zip 파일로 등록된 것을 확인할 수 있습니다.

CodeDeploy

EC2에 IAM 역할 추가

• IAM에서 역할 탭에서 역할 만들기 클릭

• AWS 서비스 선택 후 EC2를 선택해줍니다.

• AmazoneEC2RoleforAWSCodeDeploy를 추가합니다.

• 역할 이름 등록 후 저장!

• EC2에 역할을 수정해줍니다.



 
만들어 놓은 역할을 설정해주세요.

CodeDeploy IAM 역할 생성

• 위와 역할 만들기, AWS 서비스 & EC2 선택 동일

• AWSCodeDeployRole 권한 추가

• 역할 이름 등록 후 저장!

• 🫥… 신뢰관계도 추가해봅시다. [추가사항] → 이거 추가 안하면 CodeDeploy 등록할 때 검색 안됨…
• 신뢰 정책 편집을 클릭해주세요.
• Service 부분에 CodeDeploy도 추가해줍니다.
• 끗.
 

CodeDeploy 애플리케이션 만들어!

• CodeDeploy의 시작하기 탭에서 애플리케이션 생성 버튼 클릭

• 애플리케이션 이름을 등록하고 생성해줍니다.

• 그리고 바로 배포 그룹을 생성해줍니다.

• 배포 그룹 이름 지정

• 서비스 역할 추가

• 환경 구성 등록 : Amazon EC2 인스턴스 선택 및 Name 태그 등록

• 배포 설정 확인해 주시구요.

• 서버 1대이니까.. 로드 밸런서는 OFF 시켜줍니다.

• 이제 저장하면 끗.

CodeDeploy Agent 설치

• EC2에 접속해서 CodeDeploy를 설치해줍니다.

• deploy.yml - CodeDeploy 설정 정보 추가
deploy.yml → 설정 추가
• application-name : CodeDepoly에서 만든 이름을 설정하면 될듯…? 🤔
• deployment-group-name : 위에서 설정한 배포그룹을 설정해줍니다.
• s3-location 부분
• bucket : 버킷 이름
• bundleType : 확장자…?
• key : 폴더 경로가 포함되어 있다면 폴더 경로까지 합쳐서 작성해주세요.

appspec.yml, deploy.sh 생성

• deploy.sh 의 경우에는 scripts 안에 생성 (선택 사항: 루트에 만드셔도 됩니다.)

• appspec.yml 파일도 생성해줍니다.

appspec.yml 파일 작성

depoly.sh 파일 작성

• PID 찾는 부분이 안되면… 명령어는 알맞게 변경해주세요. 😓

🐶 되는지 확인해 봅시다.

• Github Action 확인 → 정상적으로 Code Deploy가 작동한 것을 볼 수 있습니다.

• 실제 API로 확인해 봅시다.
• 초기 세팅





• 메서드 변경
• Commit & PR 및 Action 확인



굳… 👍
• Code Deploy 배포 확인 → AWS에서 확인 가능
• API 확인



굳… 👍
• 끗.
 
 
 
 
 
 

트러블 슈팅

🐶 읽어봐야 되는 글

데이터 기반으로 지속적인 CI/CD 개선 환경 만들기

지난 1993년에 개봉했던 사랑의 블랙홀 이라는 영화를 기억하시나요? 남자 주인공이 2월 2일 성촉절(Groundhog Day, 미국에서 마멋이 겨울잠에서 깨어난다고 여기는 날) 하루를 끊임없이 반복해서 살게 되면서, 사랑을 얻기 위해 매일매일 좀 더 완벽한 사람으로 변해가는 로맨틱 코미디 영화입니다. 빌 머레이(Bill Murray)가 연기한 극 중 필 코너스(Phil Connors)의 목표는 자기 자신을 개선하고 자신의 목표를 달성하는 방법을 단계별로 배우는 것이었습니다.

https://engineering.linecorp.com/ko/blog/build-a-continuous-cicd-environment-based-on-data/

🔖 참고 사이트

CI/CD란 무엇인가 (Feat. DevOps 엔지니어)

안녕하세요. 개발자의 용어를쉽고 명확하게 설명해드리는개발자 김모씨입니다. CI/CD ?! 개발자로 밥먹고 사시는 분들이시라면,혹은 IT서비스 업계에 종사하시는 분들이라면,한 번 쯤은 들어봤을 법한 용어인데요.흔히, DevOps 엔지니어의 핵심 업무 라고들 하죠. 그런데 혹시 정확히 무슨 뜻인지 모르시면서고개를 끄덕거리고 넘어간 경험....있으신가요? 우리 서로가 무슨 일을 하고 있는지는 알아야 하잖아요....그래서 오늘은 제가,이 CI/CD 가 무엇이고이 쪽 분야가 왜 중요한지!

https://artist-developer.tistory.com/24

1. Github Action & AWS Beanstalk 배포하기 - Github Action으로 빌드하기

기존에 사이드 프로젝트를 만들면 다음과 같은 환경에서 진행을 해왔습니다. TravisCI & AWS Code Deploy TravisCI & AWS Beanstalk 상황에 따라 골라 쓰긴 했지만, 큰 불편함이 없었는데요. 최근 대세가 TravisCI에서 Github Action으로 넘어갔음이 느껴져 Github Action과 Beanstalk 조합에 대한 글을 쓰게 되었습니다. Github Action & AWS Code Deploy 조합은 wbluke님의 시리즈 를 참고해주시면 됩니다.

https://jojoldu.tistory.com/543

Github Actions + CodeDeploy + Nginx 로 무중단 배포하기 (1)

안녕하세요!이번 시리즈에서는 제목에서와 같이 Github Actions 와 CodeDeploy, 그리고 Nginx 를 사용하여 하나의 서버에서 최소 규모의 무중단 배포를 진행하는 방법에 대해 정리해보려고 합니다.관련 코드는 Github 저장소 에서 확인하실 수 있습니다. CI/CD 와 같이 인프라, 배포 환경을 구축하기 위해서는 내가 만들고자 하는 전체 그림을 숙지하는 것이 가장 중요하다고 생각합니다.그래야 진행 삽질 중에 막혔을 때 어느 부분이 문제일지 빠르게 유추해 볼 수 있기 때문입니다.

https://wbluke.tistory.com/39

Github Actions CI + CodeDeploy로 CI/CD 구현하기

CI 도구로 Github Actions를 사용하고 CD로는 AWS CodeDeploy를 사용하여 Spring Gradle 프로젝트 자동 배포를 구현해보겠습니다. 진행하고자 하는 아키텍쳐는 위의 그림과 같습니다. Github에 push 시, Github Action이 자동으로 실행 (build하여 jar 생성) jar 와 shell script 파일을 압축하여 S3로 upload. EC2에 설치되어 있는 CodeDeploy Agent가 S3에 업로드 된 zip 파일을 가져와서 배포를 진행.

https://velog.io/@bluewind8791/Github-Actions

Mac OS에 AWS Cli 설정하기

AWS 커맨드 라인 인터페이스(AWS Command Line Interface, aws cli)는 AWS 서비스를 관리하는 통합 도구입니다. 여러 AWS 서비스를 명령줄에서 제어하고 스크립트를 통해 자동화할 수 있습니다. 설치 Mac OS는 Homebrew를 사용하면 명령어로 간단히 설치 할 수 있습니다.

https://longtermsad.tistory.com/13

Amazon Linux jdk 17 설치방법

검색해도 잘 안나와서 정리 wget https://download.oracle.com/java/17/latest/jdk-17_linux-x64_bin.rpm sudo rpm -ivh jdk-17_linux-x64_bin.rpm sudo alternatives --config java java -version 마지막 alterna..

https://binux.tistory.com/122

Gradle로 특정 Profile이 active되게 test 돌리는 방법

실제 운영을 하다보면 Profile이 local, development, production 처럼 환경에 따라 달리 설정하게 되는데, test를 돌릴 때 특정 profile의 정보를 읽어들어 build되게 하려면 아래 명령어로 하면 된다. > SPRING_PROFILES_ACTIVE=[profile_name] ./gradlew clean test 주의! -Dspring.profiles.active 옵션으로는 실제 목적에 맞게 기능하지 않는다. 이거는 java 옵션이라서 그런 듯 함...

https://pikanpie.wordpress.com/2016/07/26/gradle%EB%A1%9C-%ED%8A%B9%EC%A0%95-profile%EC%9D%B4-active%EB%90%98%EA%B2%8C-test-%EB%8F%8C%EB%A6%AC%EB%8A%94-%EB%B0%A9%EB%B2%95/

AWS EC2 Ubuntu 18.04에 Github SSH 설정하기

들어가기 앞서 Gihhub 레포지토리에 push를 하거나, private 레포지토리를 받아오기 위해서는 Github 계정이 필요합니다. 하지만 매번 할 때마다 비밀번호를 입력하기는 귀찮습니다. 그래서 Github ssh key를 등록하여 손쉽게 ssh 통신으로 push / pull 하는 법을 배우겠습니다. SSH 키 생성 먼저 SSH 키를 생성하...

https://velog.io/@loakick/2019-11-19-0011-%EC%9E%91%EC%84%B1%EB%90%A8-2ck34lupye

9.2: submodule 갱신 (update) 하기

GitNotes.9-2.md submodule 은 다른 저장소의 특정 커밋을 참조하게 되어있다. 모든 submodule 들에 대해 참조 중인 상태로의 checkout 을 수행하려면, 다음과 같은 명령어를 이용한다. 가끔씩은 submodule 이 참조 중인 상태를 이용하기보다 원격 저장소에서 가장 최신 상태를 update 해오고 싶을때가 있다. 하나의 명령어를 사용하여 모든 submodule 을 원격 저장소의 가장 최신 상태로 update 하려면 아래와 같이 수행한다.

https://nochoco-lee.tistory.com/88

GitHub Action + S3 + CodeDeploy를 이용한 CI/CD (2/2)

앞서 GitHub Action, Aws CodeDeploy, CI/CD가 무엇인지 알아보았다. 이번에는 GitHub Action + AWS CodeDeploy로 CI/CD 구현 예시를 정리해보았다. EC2 인스턴스(Amazon Linux 2 AMI (HVM), SSD Volume Type)를 생성하고 접속해 CodeDeploy Agent를 설치한다. (인스턴스 유형을 프리티어로 생성하면 CodeDeploy에 오류가 발생하기 때문에 최소한 t2.small로 생성해야 한다.)

https://devbksheen.tistory.com/140

[Github Actions][Codedeploy] CI/CD 구축하기 (1)

Github Actions와 AWS Codedeploy 를 이용해서 CI/CD를 구축해보았다. Travis CI, Jenkins등은 사용해보지 않았지만 Github actions로 시작해보는 것도 괜찮은 것 같다. 자동배포라고하면, 구축하는 것 자체에 시간이 너무 뺏길것 같고, 구현하기 바빠서 미뤘었는데 처음 한번만 제대로 해놓으면 그 다음부터는 작은 부분들만 수정해서 바로 적용할 수 있기때문에 처음에 시간을 들여서라도 한번 해보는게 좋은 것 같다고 느꼈다!

https://suyeoniii.tistory.com/103

Github Actions CD: AWS EC2 에 Spring Boot 배포하기

애플리케이션을 개발하면 외부에서도 접근 가능하도록 클라우드 환경에 배포합니다. 이전에 포스팅 했던 AWS 1편에서는 마지막에 scp 명령어로 로컬에 존재하는 빌드 파일을 EC2 인스턴스로 복사한 후 ssh 로 접속해서 실행시켰습니다. 하지만 매 배포마다 이렇게 하면 굉장히 번거롭고 실수할 가능성도 높아집니다. 그래서 이런 수작업을 자동화하는 여러 가지 툴과 기법들이 등장했고 Github Actions 도 그 중 하나입니다.

https://bcp0109.tistory.com/363

Spring Boot 배포 자동화(CI/CD) : Github Actions와 AWS CodeDeploy

먼저 AWS Cloud 환경에서 필요한 선행 작업을 안내하고, Github Actions와 AWS CodeDeploy에서 사용할 스크립트에 대해 설명하겠다. 디플로이용 계정을 만들어 아래 정책을 연결 AmazonS3FullAccess AWSCodeDeployFullAccess 이 사용자는 Github Actions에서 S3, CodeDeploy에 접근하기 위해 사용하는 IAM 계정이다. 액세스키와 시크릿키를 잘 저장해두자. Github Secret에 저장할거다. 참고 : 아래 EC2, CodeDeploy에서 생성하는 IAM 서비스역할과 사용자는 다르다.

https://prohannah.tistory.com/183

github action으로 ec2에 자동배포하기1

우아한테크캠프 마지막 프로젝트 때 나는 자동배포부분을 맡지 않아서 꼭 혼자서 다시 해보고 싶었다. 그리고 삽집도 많이했는데 다시 삽질하지 않겠다는 의지(?)를 갖고 블로그에 글을 정리한다. GitHub Actions를 사용하면 이제 세계적 수준의 CI/CD로 모든 소프트웨어 워크플로를 쉽게 자동화할 수 있습니다. GitHub에서 바로 코드를 빌드, 테스트 및 배포하세요.

https://ms3864.tistory.com/381

Jenkins를 활용한 스프링부트 앱 CI/CD 쉽게 시작하기

목차 1. 개요 2. Azure 리소스 그룹 만들기 3. 가상 머신 만들기 4. 가상 머신에 접속 5. WAS서버용 VM에 필요한 소프트웨어 설치 6. Jenkins서버용 VM에 필요한 소프트웨어 설치 7. Jenkins 접속 및 설정 8. Jenkins CI/CD 환경 설정 시작하기 9. Jenkins CI/CD 환경 설정 상세 10. CI/CD 수행과 서비스 기동 누구나 새로운 IT환경에 노출됩니다.

https://devocean.sk.com/blog/techBoardDetail.do?ID=163889