[CI/CD] GitLab CI 파이프라인 생성 시 주의사항

🚀 사건의 전말

GitLab 으로 버전 관리를 하는 프로젝트에 CI, 지속적 통합을 적용하기 위해서는 YAML 파일 .gitlab-ci.yml 에 프로젝트 리포지토리에 변경이 일어날 때마다 실행될 파이프라인에서 사용할 명령어들로 구성된 스크립트를 작성해야 한다. 내 프로젝트에서는 Docker 를 이용해 애플리케이션을 Gradle 로 빌드하여 Docker 이미지를 만들어야 했다.

우선 이슈를 만들었다.

아래와 같이 YAML 파일을 작성하였다. 레포지토리에 있는 Dockerfile을 사용해서 Docker 이미지를 생성한다. 그리고 깃랩의 컨테이너 레지스트리에 등록한다.

stages:
  - dockerbuild-push

package:
  image: docker:latest
  stage: dockerbuild-push
  services:
      - docker:dind
  before_script:
      - docker login registry.gitlab.com -u $GITLAB_USER -p $GITLAB_PW
  script:
      - echo $GITLAB_USER 로 로그인했습니다. 스크립트를 실행합니다.
      - docker build -t registry.gitlab.com/$GITLAB_USER/$PROJECT_NAME . 
      - docker push registry.gitlab.com/$GITLAB_USER/$PROJECT_NAME
  after_script:
      - docker logout

새 브랜치에 .gitlab-ci.yml 파일을 생성했다.

파이프라인에서 사용되는 $GITLAB_USER, $GITLAB_PW, $PROJECT_NAME 의 값은 환경변수 지정을 통해 불러올 수 있게 설정하고자 했다.

GITLAB_USER 라는 환경 변수의 값으로 fy16sj 를 할당했다.

🎃 사건의 발생

 

하지만 파이프라인이 실행될 때 GITLAB_USER 환경 변수를 불러오지 못하는 것을 터미널에서 발견했다.

지정해준 fy16sj 가 아닌 빈 값이 불러와진다

🔑 사건의 해결

 

이후 한참동안 환경 변수를 별도 브랜치에서 불러올 수 없는 이유에 대해 찾아보았고, 검색 결과의 대부분은 서로 다른 브랜치별로 환경 변수를 설정하는 방법에 관한 내용이었다. 출처는 아래 밝혔다.

 

구글링을 통해 찾은 글. YAML 파일 생성 시 템플릿을 사용해서 여러 버전을 만들어서 브랜치 별로 다른 버전을 사용하라는 말이었다.

 

하지만 도움이 되는 글은 없었고, CI/CD 의 Settings 에서 환경 변수 설정 탭을 계속해서 보던 중 한 줄에 눈이 갔다.

protected 상태의 브랜치와 태그가 달린 곳에서 실행되는 파이프라인에만 환경 변수를 불러올 수 있게 내보낸다고 쓰여있다.

그렇다. 환경 변수를 protect 하도록 체크하면 protected 상태의 브랜치의 파이프라인만 환경 변수를 사용할 수 있게 되어서 현재 유일한 protected 상태인 메인 브랜치의 파이프라인에서만 사용할 수 있었고, 등록한 모든 환경 변수가 protect variable 에 체크가 되어있었다.

protected 상태의 브랜치는 main 하나이다.

 

체크를 해제하고 나니, 정상적으로 환경 변수를 불러오는 것을 확인할 수 있었다. 물론 아래처럼 다른 에러가 발생했다.

또 다른 에러가 발생했다.

내용을 보니, Dockerfile 이 문제였다. "java" 명령어를 실행하는 부분을 확인했는데, 아래와 같이 백슬래쉬(\) 가 매 문자열 뒤에 붙도록 작성했었다. 기존 다른 프로젝트의 Dockerfile 에서도 백슬래쉬를 사용했지만, 모두 띄어쓰기가 되어 있었다.

왼쪽이 현 프로젝트, 오른쪽이 기존 다른 프로젝트들의 Dockerfile ENTRYPOINT 작성 모습이다.

띄어쓰기 차이만 있다고 생각한 나는 무엇이 잘못된지 알지 못하겠어서 우선 백슬래쉬를 모두 지우고 push 후 파이프라인 실행 여부를 확인했는데, 작동이 되었다. 나중에 알게 된 사실은 기존 프로젝트들의 Dockerfile 에는 "java" 명령어 전에도 백슬래쉬(\) escape character 가 있어서 newline character 를 인식하지 못하게 만들었고, 나의 프로젝트의 Dockerfile 은 "java" 전에 newline character 가 있는 것으로 인식하도록 작성되어 있었다는 사실이었다.

 

이후에 한 가지 더 에러가 발생했는데, 놀랍게도 아래와 같이 COPY --from= 이후에 띄어쓰기인 whitespace 가 있어서 발생한 에러였다. Dockerfile 은 띄어쓰기나 줄바꿈 하나에도 예민하다는 사실을 명심하자 😂.

builder 앞에 띄어쓰기가 되어 있다.

결론

에러가 발생된 이후 해결 시간이 지연된 가장 큰 원인은 꼼꼼하게 내가 한 작업들의 세부적인 사항들을 살피지 않은 것이었다. 처음에 모두 세세하게 신경 쓰는 것이 Best Practice 이겠지만, 에러가 발생한 이후에 시간을 돌릴 수는 없으니, 지난 상황들을 되짚어보면서 놓친 것이 없는지 살펴보는 습관을 가져야겠다.

출처

https://forum.gitlab.com/t/use-variables-per-branch-in-gitlab/43685/2

Use variables per branch in gitlab