🚨트러블 슈팅

.travis.yml 파일을 작성했던 모든 과정들을 트러블슈팅하면서 포스팅해보겠다..
긴 여정이 될듯..

아직 이미지 파일 및 컴포넌트 설정 파일등을 배포도 하지못해서 EC2에 배포 후 실행은 일단 수동으로 하는 것을 목표로 하였다.

---

참고

공식 doc

Travis CI 빌드 스테이지 : https://docs.travis-ci.com/user/build-stages/
Travis CI CodeDeploy: https://docs.travis-ci.com/user/deployment/codedeploy/
Travis CI rake aborted: https://travis-ci.community/t/no-rakefile-found-when-adding-travis-to-a-github-project/3520

잘쓰신 블로그님

https://devlog-wjdrbs96.tistory.com/317
https://devlog-wjdrbs96.tistory.com/search/%EB%AC%B4%EC%A4%91%EB%8B%A8%20%EB%B0%B0%ED%8F%AC%ED%95%98%EA%B8%B0

---

워크플로우 작성 시작

찾아 봤던 대부분의 .travis.yml 파일들은 모두 큰 단위의 한 블럭에 들어가 있었음...
뭔가 travis.yml 파일 내에서도 각 단계별로 작업을 수행할 수 있는 방법이 따로 있는가? 고민해서 GPT에게도 물어보았다.

그런 과정에서 .travis.yml 파일 안에서 워크플로우를 정의하는 방법은 jobs, include, stage 블럭을 사용하는 것이였다.

---

첫 번째 .travis.yml

jobs:
  include:
    - stage: SpringBoot gradle build
      language: java
      jdk:
        - openjdk11
      cache:
        directories:
          - '$HOME/ .m2/repository'
          - '$HOME/ .gradle'
      before_install:
        - chmod +x gradlew
      script:
        - ./gradlew clean build
      before_deploy:
        - zip -r prac-built ./docker-compose.yml
        - mkdir -p deploy
        - mv prac-built.zip deploy/prac-built.zip

    - stage: Build Docker image
      sudo: required
      language: generic
      services:
        - docker
      script:
        - docker build -t $SPRING-REPO -f ./Dockerfile .
        - docker build -t $NGINX-REPO -f ./Dockerfile-nginx .
        - docker login -u $DOCKER_USER -p $DOCKER_PASS
        - docker push $SPRING-REPO
        - docker push $NGINX-REPO

    - stage: Deploy to EC2
      deploy:
        - provider: s3
          access_key_id: $AWS_ACCESS_KEY
          secret_access_key: $AWS_ACCESS_SECRET
          bucket: practice-build
          region: ap-northeast-2
          skip_cleanup: true
          acl: private
          local_dir: deploy
          wait-until-deployed: true

        - provider: codedeploy
          access_key_id: $AWS_ACCESS_KEY
          secret_access_key: $AWS_ACCESS_SECRET
          bucket: practice-build
          key: SpringBoot.zip
          bundle_type: zip
          application: practiceservice
          deployment_group: practiceservice-group
          region: ap-northeast-2
          wait-until-deployed: true

---

1-1) 환경 변수 이슈

We were unable to parse one of your secure environment variables.
Please make sure to escape special characters such as ' ' (white space) and $ (dollar symbol) with \ (backslash) .
For example, thi$isanexample would be typed as thi\$isanexample. See https://docs.travis-ci.com/user/encryption-keys.

환경 변수를 지정할 때 레포이름을 노출 시키지 않으려고 SPRING-REPO, NGINX-REPO 이런식으로 이름을 줬었다.
다른 환경변수는 _(언더바)를 잘 사용해놓고 해당 환경변수에 -(하이픈)을 써버려서 Travis CI가 동작하는 와중에 이를 식별하지 못한것... -(하이픈)을 \_(언더바)로 바꿔주었다.

---

1-2) travis.yml stage 별 독립된 VM 공간 사용

🚨문제

첫 번째로 올렸을 때 .jar 파일 빌드는 성공했지만, 도커 이미지 빌드와, 푸시에서 오류가 났었다. 그래서 Travis CI 로그를 확인해보니

• (라인 246) 1번째 단계에서 분명히 gradlew clean build 명령어를 통해 .jar파일을 빌드 성공했는데 왜 jarfile을 찾을 수 없다고 하는건지 도무지 이해가 되지 않았다..
• 혹시나 이전 stage에서 빌드한 정보를 다음 stage 에서 알아 볼 수 없는 거라는 생각 밖에 들지 않아서 gpt 한테 물어봤다.

☕ 가정

🔑 문제점 확인

생각했던 가정이 맞았고, 이전 단계에서 아무리 빌드를 성공하고 .jar파일을 만들어도

FROM openjdk:11
ARG JAR_FILE=build/libs/*.jar
COPY ${JAR_FILE} app.jar
ENTRYPOINT ["java","-jar", "-Dspring.profiles.active=${active}", "-Duser.timezone=Asia/Seoul", "/app.jar"]

다음 단계에서는 다른 환경에서 실행되기 때문에 해당 도커파일이 바라볼 .jar파일을 찾을 수 없다는 것...

Travis CI 공식 문서- 빌드 단계

🔈 해결 방법

그래서 해결하려면, .jar파일은 gradle을 통해 빌드하자마자 같은 작업 단위에서 도커 이미지 빌드 후 도커 허브에 바로 푸시 해야 겠다고 생각해서 "Docker Build Image" stage의 스프링부트 프로젝트를 도커 빌드 하는 부분을 처음 stage로 옮겨서 같이 동작 하도록 바꿨다.

after_script:

after_script: 안에는 단순 명령어만 작성하여야함.

---

두 번째 .travis.yml

before_deploy:
  - zip -r prac-built ./docker-compose.yml
  - mkdir -p deploy
  - mv prac-built.zip deploy/prac-built.zip


jobs:
  include:
    - stage: SpringBoot gradle build & Build Gradle Docker Image
      language: java
      jdk:
        - openjdk11
      #cache:
      #  directories:
      #    - '$HOME/ .m2/repository'
      #    - '$HOME/ .gradle'
      before_install:
        - chmod +x gradlew
      script:
        - ./gradlew clean build
        - sudo systemctl start docker
        - docker build -t $SPRING_REPO -f ./Dockerfile .
        - echo $DOCKER_PASS | docker login -u $DOCKER_USER --password-stdin
        - docker push $SPRING_REPO

    - stage: Build Nginx Docker image
      sudo: required
      language: generic
      services:
        - docker
      script:
        - docker build -t $NGINX_REPO -f ./Dockerfile-nginx .
        - echo $DOCKER_PASS | docker login -u $DOCKER_USER --password-stdin
        - docker push $NGINX_REPO

    - stage: Deploy to EC2
      deploy:
        - provider: s3
          access_key_id: $AWS_ACCESS_KEY
          secret_access_key: $AWS_ACCESS_SECRET
          bucket: practice-build
          region: ap-northeast-2
          skip_cleanup: true
          acl: private
          local_dir: deploy
          wait-until-deployed: true

        - provider: codedeploy
          access_key_id: $AWS_ACCESS_KEY
          secret_access_key: $AWS_ACCESS_SECRET
          bucket: practice-build
          key: SpringBoot.zip
          bundle_type: zip
          application: practiceservice
          deployment_group: practiceservice-group
          region: ap-northeast-2
          wait-until-deployed: true

---

2-1) language: 미 설정 이슈

🚨문제

이제 도커 이미지 빌드 및 푸시까지는 잘되는데 배포부분이 문제였다.. 이전에 도커를 사용하지 않고 단순 S3 + CodeDeploy를 쓸때는 rake aborted! 라는 오류를 본적이 없는데 왜 나는건지 도무지 또 이해가 되지 않았음..

🔈 해결

https://travis-ci.community/t/no-rakefile-found-when-adding-travis-to-a-github-project/3520
3번째 스테이지에서 language: 를 설정해주지 않아서 발생한 문제였음..
-> 해당 스테이지에 language: generic 을 추가해줌

---

세 번째 .travis.yml

branches:
  only:
    - master

services:
  - docker

jobs:
  include:
    - stage: SpringBoot gradle build & Build Gradle Docker Image
      language: java
      jdk:
        - openjdk11

      #cache:
      #  directories:
      #    - '$HOME/ .m2/repository'
      #    - '$HOME/ .gradle'
      before_install:
        - chmod +x gradlew
      script:
        - ./gradlew clean build
        - docker build -t $SPRING_REPO -f ./Dockerfile .
        - echo $DOCKER_PASS | docker login -u $DOCKER_USER --password-stdin
        - docker push $SPRING_REPO

    - stage: Build Nginx Docker image
      sudo: required
      language: generic
      script:
        - docker build -t $NGINX_REPO -f ./Dockerfile-nginx .
        - echo $DOCKER_PASS | docker login -u $DOCKER_USER --password-stdin
        - docker push $NGINX_REPO

    - stage: Deploy Stage
      language: generic

      before_deploy:
        - zip -r prac-built ./docker-compose.yaml
        - mkdir -p deploy
        - mv prac-built.zip deploy/prac-built.zip
      deploy:
        - provider: s3
          access_key_id: $AWS_ACCESS_KEY
          secret_access_key: $AWS_ACCESS_SECRET
          bucket: practice-build
          region: ap-northeast-2
          skip_cleanup: true
          acl: private
          local_dir: deploy
          wait-until-deployed: true

        - provider: codedeploy
          access_key_id: $AWS_ACCESS_KEY
          secret_access_key: $AWS_ACCESS_SECRET
          bucket: practice-build
          key: SpringBoot.zip
          bundle_type: zip
          application: practiceservice
          deployment_group: practiceservice-group
          region: ap-northeast-2
          wait-until-deployed: true

---

3-1) S3 키 값을 deploy에서 올바르게 설정해야함.

🚨문제

S3에는 잘 올라가는데 Deploy 에서 막히길래 EC2 인스턴스에서 로그를 확인해 보았다.

2023-09-20T08:57:25 ERROR [codedeploy-agent(2146)]: 
InstanceAgent::Plugins::CodeDeployPlugin::CommandPoller: 
Error during perform: Aws::S3::Errors::NoSuchKey - The specified key does not exist.

🔈 해결

키가 존재하지 않음..

S3 버킷에 들어간 배포파일의 key 값과 travis.yml 파일에 codedeploy 블록에서의 key 값을 똑같이 해줘야하는데 실수로 전에 만들었던 travis.yml 을 수정하지 않아서 발생했던 오류였다.

        - provider: codedeploy
          access_key_id: $AWS_ACCESS_KEY
          secret_access_key: $AWS_ACCESS_SECRET
          bucket: practice-build
          key: SpringBoot.zip -> prac-build.zip
          bundle_type: zip
          application: practiceservice
          deployment_group: practiceservice-group
          region: ap-northeast-2
          wait-until-deployed: true

---

4-1) nginx .conf 파일 오타..

🚨문제

2023-09-20 18:40:40.620  INFO 1 --- [nio-8081-exec-1] o.apache.coyote.http11.Http11Processor   : Error parsing HTTP request header
 Note: further occurrences of HTTP request parsing errors will be logged at DEBUG level.

java.lang.IllegalArgumentException: The HTTP header line [x-forwarded=Proto: http] does not conform to RFC 7230. The request has been rejected.
        at org.apache.coyote.http11.Http11InputBuffer.skipLine(Http11InputBuffer.java:1074) ~[tomcat-embed-core-9.0.79.jar!/:na]
        at org.apache.coyote.http11.Http11InputBuffer.parseHeader(Http11InputBuffer.java:905) ~[tomcat-embed-core-9.0.79.jar!/:na]
        at org.apache.coyote.http11.Http11InputBuffer.parseHeaders(Http11InputBuffer.java:591) ~[tomcat-embed-core-9.0.79.jar!/:na]
        at org.apache.coyote.http11.Http11Processor.service(Http11Processor.java:286) ~[tomcat-embed-core-9.0.79.jar!/:na]
        at org.apache.coyote.AbstractProcessorLight.process(AbstractProcessorLight.java:63) ~[tomcat-embed-core-9.0.79.jar!/:na]
        at org.apache.coyote.AbstractProtocol$ConnectionHandler.process(AbstractProtocol.java:926) ~[tomcat-embed-core-9.0.79.jar!/:na]
        at org.apache.tomcat.util.net.NioEndpoint$SocketProcessor.doRun(NioEndpoint.java:1790) ~[tomcat-embed-core-9.0.79.jar!/:na]
        at org.apache.tomcat.util.net.SocketProcessorBase.run(SocketProcessorBase.java:52) ~[tomcat-embed-core-9.0.79.jar!/:na]
        at org.apache.tomcat.util.threads.ThreadPoolExecutor.runWorker(ThreadPoolExecutor.java:1191) ~[tomcat-embed-core-9.0.79.jar!/:na]
        at org.apache.tomcat.util.threads.ThreadPoolExecutor$Worker.run(ThreadPoolExecutor.java:659) ~[tomcat-embed-core-9.0.79.jar!/:na]
        at org.apache.tomcat.util.threads.TaskThread$WrappingRunnable.run(TaskThread.java:61) ~[tomcat-embed-core-9.0.79.jar!/:na]
        at java.base/java.lang.Thread.run(Thread.java:829) ~[na:na]

🔈 해결