소스의 출처가 되는 원격 레포지토리의 구조에 따라 세부 경로가 달라지게 되는데, gradlew 가 있는 곳이 루트디렉토리가 되게끔 설정을 해주면 된다. 나 같은 경우는 아래와 같이 되어있어서 한 단계 더 들어가서 설정해주도록 하였다.
//git 원격 레포지토리 내 디렉토리 구조
repository root
L test-project
L gradle/wrapper
L src
L buildspec.yml
L build.gradle
L gradlew
L gradlew.bat
L setting.gradle
L .gitignore
L README.md
# buildspec.yml version:0.2phases:build:commands: - echo Entered the build phase... - echo Build Starting on `date` - cd test-project# 루트에서 프로젝트로 한 depth 더 이동하기 - chmod +x ./gradlew# gradlew 가 있는 위치에서 빌드 명령어 시작 - ./gradlew clean buildpost_build:commands: - echo Entered the post_build phase... - echo Build completed on `date` - echo $(basename ./build/libs/*.jar) - pwdcache:paths: - '/root/.gradle/caches/**/*'
build : 프로젝트의 빌드가 시작되는 시점이다. gradlew 실행 권한을 부여하고, 클린 후 빌드 할 수 있도록 명령어를 추가한다.
post_build : 빌드가 끝난 시점. 빌드 결과물을 출력해서 빌드가 성공적으로 되었는지 확인한다.
cache : 해당 위치에 있는 파일들을 S3 캐시 파일로 등록한다.
2-2. 빌드 성공
위의 설정을 마치면 다시 소스코드를 커밋&푸시하여 파이프라인 프로세스를 시작한다. 소스 단계가 통과되고 빌드가 성공적으로 마무리 되면, 아래와 같이 콘솔 창에서 SUCCEEDED 를 확인 가능하다. 콘솔창을 통해서 우리가 buildspec.yml 에 설정한 각 빌드 단계별 명령어가 성공적으로 수행되었음을 알 수 있다.
빌드된 결과물은 역시 S3에 아티팩트로 저장되는데 빌드가 성공적으로 진행된 이후 S3 내에서 확인 가능하다.
디렉토리 내부에 빌드된 파일이 제대로 생성되었다면 성공적으로 마무리 된 것이다.
2-3. 이슈) buildspec.yml 파일을 찾을 수 없을 때
빌드 프로세스가 일단 시작되면, 파이프라인은 buildspec.yml 파일을 찾는다. 1편에서 다뤘던 빌드 프로세스 설정시 buildspec.yml 경로를 잘못 입력했을 경우, buildspec.yml 파일을 찾지 못하여 빌드에 실패하게 된다. 따라서 경로 설정이 정말 중요하다. 빌드 시 콘솔 창에서 그 과정들이 메시지로 출력되므로 오류시에는 오류 메시지를 천천히 읽고 그에 맞게 대응하는 것이 중요하다.
2-4. 이슈) buildspec.yml 내부의 경로 설정이 잘못되었을 때
빌드 프로세스를 생성할때 경로설정을 잘 했다고 하더라도, buildspec.yml 파일 내부에서 명령어를 잘 못 입력할 경우, gradlew 파일을 찾을 수 없다는 오류가 발생해서 빌드에 실패하게 된다. 앞서 말한대로 build 단계에서 본인의 gradlew 파일이 있는 곳까지 가서 빌드 명령어를 잘 수행할 수 있도록 디렉토리 위치를 이동하는 명령어를잘 설정해주어야 한다. 위에서는 cd test-project 명령어를 추가하여 gradlew 가 있는 위치까지 디렉토리를 이동해주었다.
3. 배포 스테이지 실행하기
빌드가 성공적이라면 역시 자동으로 배포 스테이지로 이동하게 된다. 배포 스테이지 역시 추가적인 설정들이 더 필요하기에 배포에 실패할 것이다. 아래를 통해 추가 설정 후 다시 배포 스테이지를 진행해보자.
3-1. IAM > EC2 서버를 위한 역할 생성하기
우선 운영중인 EC2 서버가 있다고 가정하고 (없다면 하나 만들고) EC2 서버의 역할을 수정해주어야 한다.
IAM > 역할 > EC2 를 선택한 후 다음을 누른다.
아래의 4가지 정책을 추가해준다.
AmazonS3FullAccess
AWSCodeDeployFullAccess
AWSCodeDeployRole
CloudWatchLogsFullAccess
태그도 필요할 경우 추가해주고, 아래와 같이 역할 이름을 추가 후 정책들을 검토한다. 문제 없을 경우 역할 만들기를 클릭하여 완료한다.
만들어진 역할을 운영중인 EC2 서버에 추가한다.
연결된 IAM 역할 없는지 확인 : EC2 > 인스턴스 클릭 > 작업 > 세부정보보기
IAM 역할 연결하기 : 작업 > 보안 > 위에서 만들어준 IAM 역할로 수정
3-2. IAM > EC2 에서 CodeDeploy Agent 용 사용자 추가하기
CodeDeploy 에서 배포가 시작되면 EC2 서버에서는 그 이벤트를 수신할 수 있어야 한다. 그를 위해서 이 이벤트를 수신하기 위한 CodeDeploy Agent 용 사용자를 추가해주어야 한다.
IAM 에서는 1) 그룹을 만들고 2) 그 그룹에 정책을 연결한 뒤 3) 해당 그룹에 들어갈 사용자를 추가해주는 방식으로 관리가 되므로 먼저 그룹을 만들어준다. (이 부분이 이해가 안간다면 이 포스팅을 참고할 것)
# 우선 apt package update$sudoaptupdate# ruby 설치$sudoaptinstallruby-full# 설치 확인을 위한 ruby 버전 확인$ruby--versionruby2.7.0p0 (2019-12-25 revision647ee6f091) [x86_64-linux-gnu]
EC2 내부에 CodeDeploy 용 agent 까지 설치를 완료했다면, 프로젝트로 다시 이동하여 배포를 위해 buildspec.yml 파일을 수정해야한다.
지난번에 설정한 내용은 코드 빌드를 위해서 각 빌드 단계별 (빌드시, 빌드 후 등) 명령어를 세팅해뒀고 캐싱을 위해 경로정도만 설정하였다. 여기에 더하여 빌드 이후 배포 단계로 넘어갈 때, 프로젝트에서 빌드 결과물인 아티팩트에 같이 포함할 파일들을 설정해줄 수 있는데, 우리는 다음과 같은 설정으로 파일들을 포함할 것이다.
version:0.2phases:build:commands: - echo Entered the build phase... - echo Build Starting on `date` - cd arirang-first - chmod +x ./gradlew - ./gradlew clean build -x testpost_build:commands: - echo Entered the post_build phase... - echo Build completed on `date` - echo $(basename ./build/libs/*.jar) - pwd#################################################### 코드를 빌드한 이후 빌드 결과물인 아티팩트에 포함시키기 위하여 새롭게 추가된 내용 artifacts:files: - appspec.yml - build/libs/*.jar - scripts/**discard-paths:yesbase-directory:arirang-first# 기본 루트 디렉토리를 설정해준다. 없으면 그냥 해당 설정 자체를 없엔다.###################################################cache:paths: - '/root/.gradle/caches/**/*'
다른 부분은 build 단계에서 최초로 생성할때와 다르지 않다.
artifacts 부분은 빌드 결과물에 포함할 파일들을 지정하는 것이다.
appspec.yml: AWS CodeDeploy 가 어떤 파일들을 어느 위치에 배포할지, 그리고 그 후에는 어떤 스크립트를 실행시킬건지 모두 관리하는 역할을 한다. 아래에서 추가해줄 예정이다.
buid/libs/*.jar : 빌드 결과로 생성된 jar 파일
scripts/**: 배포 이후 실행시킬 스크립트를 저장할 디렉토리이다. 없다면 루트 위치에 하나 만들어주자.
discard-paths : 절대경로를 버리고 루트/파일명으로 설정한다.
base-directory : 기본 루트 디렉토리를 설정해준다. 없으면 그냥 해당 설정 자체를 없엔다.
3-7. 프로젝트 내부 > appspec.yml 생성하기
앞서 말한대로 AWS CodeDeploy 가 어떤 파일들을 어느 위치에 배포하는지, 배포 후에는 어떤 스크립트를 실행하는지 관리하는 곳이 바로 이 appspec.yml 파일이다. buildspec.yml 이 있는 같은 디렉토리 상에서 파일을 생성해준다.
//디렉토리 구조
repository root
L test-project
L gradle/wrapper
L src
L appspec.yml
L buildspec.yml
L build.gradle
L gradlew
L gradlew.bat
L setting.gradle
L .gitignore
L README.md
