자바 개발자를 위한 컨테이너 이미지 빌드

쿠버네티스 기반의 시스템을 운영하고 있다면 CI/CD 과정에서 반드시 컨테이너 이미지를 생성하는 과정을 거쳐야 합니다. 이 글에서는 컨테이너의 기본 개념과 자바 개발자를 위한 효과적인 컨테이너 이미지 생성 방법을 알아봅니다.

1. 컨테이너 이미지의 기본 개념

우리는 Docker와 같은 도구를 이용해 컨테이너를 쉽게 구동합니다. 이 때 컨테이너는 이미지를 바탕으로 실행됩니다. 컨테이너의 바탕이 되는 이미지는 어떤 구조를 가지고 있을지를 살펴보기 위해 docker save 명령어를 통해 추출한 이미지 파일의 내부를 살펴봅시다.

docker save명령어를 통해 이미지를 파일로 저장한 후 압축을 해제하면 해당 디렉터리는 명세 정보를 관리하는 manifest.json, 구동과 관련된 세부 사항이 담긴 config 관련 json 그리고 디렉터리로 구분된 각각의 레이어를 포함하고 있습니다.

먼저 명세 정보를 관리하는 manifest.json을 살펴보도록 하겠습니다.

명세 정보 파일에는 세부사항이 담긴 config 파일의 이름과 이미지의 태그 정보, 그리고 [그림1]에서 보았던 각 디렉터리 하위에 있는 레이어 관련 파일의 정보가 담겨 있는 것을 볼 수 있습니다. 이미지는 이처럼 여러 레이어로 구성되어 있으며 이미지 빌드시 동일한 내용을 가진 레이어는 재사용될 수 있습니다.

다음으로 config 관련 json 파일을 살펴보겠습니다. 이 파일은 매우 길기 때문에 일부만 살펴보도록 합니다.

파일의 일부를 살펴보면 플랫폼(CPU 및 특정 OS), 노출할 포트, 환경 변수, 이미지를 컨테이너로 구동할 때 사용할 명령어, 레이블 등 이미지를 실행과 관련된 세부 사항이 이 파일에 담겨 있는 것을 알 수 있습니다.

컨테이너를 구동하는데 필요한 추가적인 옵션이나 연결할 볼륨 등을 입력하고 docker run을 실행하면 위와 같은 이미지 정보와 조합하여 컨테이너가 구동되는 것입니다.

2. 자바 개발자의 컨테이너 이미지 빌드

자바로 개발한 애플리케이션은 .jar 혹은 .war의 확장자를 가지는 패키지 파일로 만들어집니다. 이를 컨테이너 기반으로 구동하기 위해 우리는 JDK를 베이스 이미지로 가지는 Dockerfile을 작성하고 자바 패키지 파일을 이미지 내부로 복사하도록 한 후 컨테이너의 구동을 위한 ENTRYPOINT 나 CMD에 자바 애플리케이션을 구동하는 명령어를 삽입합니다. 이 방법은 매우 일반적인 방법이며 잘 동작합니다. 그러나 컨테이너 이미지의 관점에서는 약간의 비효율이 있습니다. 왜 이 방법이 비효율적인지 알아보기 전 널리 사용되는 메이븐(Maven)으로 빌드된 스프링부트 기반 자바 애플리케이션의 패키지 구조를 살펴봅시다.

이 패키지는 구동 관련 정보가 담긴 BOOT-INF 디렉터리, 명세 정보가 담긴 META-INF 디렉터리, 로더와 관련된 정보가 담긴 org 디렉터리로 구성되어 있습니다. 이 때 주목할 것은 구동과 관련된 BOOT-INF 디렉터리입니다. 사용자가 작성한 소스 코드는 BOOT-INF 하위의 classes 디렉터리에 담기게 되며, 외부에서 불러온 의존성 라이브러리들은 lib 디렉터리에 담기게 됩니다. 이 샘플 프로젝트를 기준으로 패키지의 전체 크기는 16MB이고 그 중 의존성 라이브러리 크기는 12MB입니다. 반면 직접 작성한 코드는 2KB에 불과합니다. 사용자가 작성한 코드는 빈번하게 변경되지만 의존성 라이브러리는 프로젝트가 구성된 이후 변경되는 빈도가 낮습니다. 

그럼에도 불구하고 이 프로젝트를 앞에서 설명드린 .jar와 같은 패키지 파일을 생성한 후 컨테이너 이미지 내부로 복사하는 방식으로 컨테이너 이미지를 만들 경우 매번 16MB의 용량을 차지하게 될 것입니다. 이는 이미지를 사용자의 로컬에 보관하거나 원격에 push 하거나 pull을 받을 때 디스크 사용량 및 네트워크 전송량의 비효율을 발생시킵니다. 반면에 .jar 파일을 그대로 컨테이너 이미지 내부로 복사하지 않고 사용자가 작성한 코드와 의존성 라이브러리를 분리하여 컨테이너 이미지 내부로 복사하면 이것들이 각각 컨테이너 이미지 생성시 개별 레이어를 구성하게 됩니다. 

이 경우 사용자가 작성한 소스 코드에 일부 변경이 있었다면 의존성 라이브러리와 관련된 부분은 재사용하고 사용자가 작성한 소스 코드만을 새로 이미지에 반영할 수 있게 됩니다.

3. 좀 더 쉽게 컨테이너 이미지를 생성하는 방법

생성된 .jar 파일을 통해서 효율적으로 컨테이너 이미지를 만들 수 있습니다. 하지만  이를 수행하는 단계에서 패키지의 압축을 해제하고, 일일이 레이어가 될 디렉터리를 구분하여 복사한 후 옵션을 추가한 Dockerfile을 작성해야 하는 번거로움이 있습니다. 또한 무엇보다도 도커를 구동하기 위해서는 리눅스 기반의 환경이 필요하기 때문에 윈도우 혹은 맥 기반의 개발 환경을 구축한 사용자들은 도커를 사용하기 위해 하이퍼바이저 기반의 별도 환경 구성해야 하는 번거로움이 있습니다.

이제 좀 더 쉽게 이를 수행할 수 있는 방법을 알아봅시다. 스프링부트 기반의 자바 애플리케이션 개발자가 사용할 수 있는 도구로 유명한 것은 크게 두 가지가 있습니다. 하나는 스프링부트에 통합된 Container Native BuildPacks(이하 Buildpacks)이며 또 다른 하나는 Jib입니다. Buildpacks에 대해서는 이 글에서 자세히 다루지 않고 소개를 하고 넘어가도록 하겠습니다. Buildpacks은 쿠버네티스를 관리하고 있는 CNCF에서 출시한 이미지 빌드 도구로 스프링부트와 통합하여 스프링부트 애플리케이션의 패키징 작업과 컨테이너 이미지 생성 과정을 통합할 수 있습니다. 

앞서 말씀드린 이미지의 레이어 분리 작업 또한 자동으로 수행할 수 있는 장점이 있습니다. 다만 Buildpacks은 Docker daemon에 의존적이기 때문에 윈도우나 맥 기반의 개발 환경에서 별도의 도커를 설치하거나 원격에 설치된 Docker daemon과 연결을 위한 설정이 필요하다는 단점이 있습니다. 반면에 윈도우나 맥에서도 별도의 Docker daemon 없이 컨테이너 이미지를 생성할 수 있는 도구가 Jib입니다. 그럼 Jib에 대해서 알아봅시다.

Jib은 오픈소스 컨테이너 이미지 도구로 구글이 지원하고 있습니다. 

Jib은 명령줄을 통해 사용할 수 있는 Jib CLI 혹은 자바 애플리케이션 빌드 도구인 메이븐 혹은 그레이들(Gradle)과 통합해서 사용할 수 있는 플러그인을 제공하고 있습니다. 주요한 장점으로 내세우는 것은 쉽고 빠른 레이어 재사용, Dockerfile이나 Docker daemon이 필요 없는 이미지 생성입니다.

Jib은 어떻게 윈도우나 맥에서 Docker에 의존하지 않고 이미지를 생성할 수 있는지를 생각 해 보면 1절에서 살펴본 것과 같이 컨테이너 이미지는 명세 및 설정 정보와 사용할 레이어 파일을 묶어 놓은 것이므로 이 형식에 맞춘 파일과 디렉터리만 있다면 컨테이너 이미지를 생성하는데는 특정 OS나 특정 도구가 필요한 것은 아님을 알 수 있습니다.

4. jib-maven-plugin 을 활용한 컨테이너 이미지 생성

지난 내용을 정리하자면 Jib을 통해 컨테이너 이미지를 생성하는 방법은 크게 두 가지가 있습니다. 첫 번째는 Jib CLI를 이용하는 방법입니다. 이 방법은 Jib이 지원하는 자체 방식의 YAML 파일을 이용하여 컨테이너 이미지를 생성할 수 있도록 해 줍니다. 두 번째는 자바 애플리케이션 빌드 도구의 플러그인으로 Jib 플러그인을 삽입하는 것입니다. Jib을 이렇게 사용할 경우 자바 애플리케이션을 빌드하는 작업 과정에서 컨테이너 이미지를 생성할 수 있어 매우 효율적입니다. Jib은 메이븐 및 그레이들과 통합할 수 있는 플러그인을 지원합니다. 메이븐 기반의 자바 애플리케이션에 jib-maven-plugin(이하 플러그인)을 사용하여 자바 애플리케이션을 컨테이너 이미지로 만들어 보겠습니다.

메이븐 기반의 자바 애플리케이션의 빌드 관련 정보는 pom.xml에 기록됩니다. 이 때 플러그인 정보는 <plugins></plugins> 섹션에 위치하고 있습니다. 기본적으로 별도의 플러그인 설정을 하지 않은 스프링부트 애플리케이션의 플러그인 정보는 아래와 같습니다.

이 부분의 아래에 jib-maven-plugin과 관련된 내용을 삽입하여 [그림 6]과 같은 내용이 되도록 합니다.

이때 <to></to>의 사이에 컨테이너 이미지가 push될 리포지토리 정보를 입력하고 <auth></auth>의 사이에 레지스트리에 접속할 계정 정보를 입력합니다. 위 플러그인은 빌드된 자바 애플리케이션을 컨테이너 이미지로 생성한 후 환경 변수 REGISTRY_USERNAME, REGISTRY_PASSWORD를 사용자명과 비밀번호로 도커 허브(Docker Hub)에 접속하여 webfuel/jib-test-project 리포지토리에 이미지를 push합니다.

이제 널리 사용하는 개발 도구인 인텔리제이 통합 개발 환경(IntelliJ IDEA)을 기준으로 자바 애플리케이션을 빌드하는 설정을 해 보겠습니다. 

이 때 설정을 해 주셔야할 것은 이 실행 환경 구성의 이름, 메이븐 빌드를 실행하기 위한 명령어(Run)와 앞서 pom.xml 에서 환경 변수로 읽어 오도록 설정하였던 사용자명과 비밀번호입니다. pom.xml 은 Github과 같은 소스 코드 저장소에 공유되는 파일이기 때문에 파일에 직접 계정 정보를 입력하는 것은 위험합니다. 

환경의 이름은 Name 항목에 jib-push로 지정해 주었습니다. 

Run 항목에서 입력한 빌드를 실행하기 위한 명령어의 의미는 과거 빌드된 결과물이 있다면 초기화를 시키고(clean) 애플리케이션을 컴파일(compile)한 후 jib-maven-plugin을 통해서 컨테이너 이미지를 만들고 도커 허브에 push(jib:build)한다는 의미입니다. 이 때 앞서 설명드린 것과 같이 변경되지 않은 부분에 대해서는 레이어를 재사용하기 때문에 좀 더 효율적인 이미지 생성이 이뤄집니다. 

또한 그림에서 Environment variables에 ***로 처리된 사용자명과 비밀번호 부분은 사용하는 실제 값을 입력하셔야 합니다. 이 값을 저장한 후 자바 애플리케이션 빌드를 수행하고 결과를 확인해 보겠습니다.

화면 우측 상단의 목록에서 jib-push를 선택한 후 실행을 누르면 빌드가 수행되면서 아래와 같은 결과를 확인할 수 있습니다.

Jib가 자바 애플리케이션을 레이어로 만들고 명세 정보 및 이미지를 원격 저장소로 푸시하는 것을 확인할 수 있습니다. 작업이 완료되었으면 도커 허브에서 해당 리포지토리를 확인해 보도록 하겠습니다.

pom.xml 에서 입력했던 webfuel/jib-test-project 리포지토리에 이미지가 정상적으로 push된 것을 확인할 수 있습니다. 이 과정에는 Dockerfile 작성이나 도커 설치가 필요하지 않습니다. Jib을 사용하면 OS 환경이나 도커 설치에 구애받지 않고, 자바 애플리케이션에 최적화된 구조의 이미지를 개발 도구 안에서 쉽게 생성할 수 있음을 알아보았습니다.

*이 글은 책 <컨테이너 인프라 환경 구축을 위한 쿠버네티스/도커>의 논의를 확장하기 위해 출간 이후 추가로 작성했습니다. 

작가

• 조훈(CNCF & NCP 앰버서더)

시스템/네트워크 IT 벤더의 경험 이후, 메가존 GCP 클라우드 팀에서 쿠버네티스와 연관된 모든 프로젝트에 대한 Tech Advisor 및 Container Architecture Design을 제공하고 있다. 페이스북 ‘IT 인프라 엔지니어 그룹’의 운영진을 맡고 있으며, 오픈 소스 컨트리뷰터로도 활동한다. 지식 공유를 위해 인프런/유데미에서 앤서블 및 쿠버네티스에 관한 강의를 하기도 한다. 책 <컨테이너 인프라 환경 구축을 위한 쿠버네티스/도커> 등 3권을 썼다.CNCF(Cloud Native Computing Foundation) 앰버서더및NCP(Naver Cloud Platform) 쿠버네티스 앰버서더로서도 쿠버네티스 생태계가 더 활발하게 퍼질 수 있도록 기여하고 있다. 

• 심근우

삼성 SDS 클라우드 개발팀에서 쿠버네티스 클러스터를 운영하면서 자동화 플랫폼을 개발하고 있다. 개발자와 운영자의 역할 사이에서 균형을 찾으려 항상 노력하고 있고, 블로그를 통해 지식을 기록하고 전파하는 것을 좋아한다. 페이스북 ‘IT 인프라 엔지니어 그룹’과 ‘카프카 한국 사용자 모임(KafkaKRU)’의 운영진을 맡고 있다.

• 문성주 

체커(CHEQUER) 사의 DevOps Engineer로서 쿠버네티스의 멀티 클러스터 관리 방법론과 쿠버네티스 구현체(CAPI, OCI)에 대한 명세와 컨테이너 리소스 격리 방법에 대한 연구를 병행하고 있다. 이런 연구 활동을 기반으로 쿠버네티스 볼륨 테스트 파트에 컨트리뷰션했다. 본업은 쿠버네티스 오퍼레이터와 같은 CRD(커스텀 리소스)를 개발해 현업에서 쿠버네티스를 좀 더 편리하게 사용할 수 있도록 돕는 일이다. 또한, 페이스북 그룹 ‘코딩이랑 무관합니다만'과 ‘IT 인프라 엔지니어 그룹'의 운영진을 맡고 있다.

<원문>

자바 개발자를 위한 컨테이너 이미지 빌드

요즘IT의 모든 콘텐츠는 저작권법의 보호를 받는 바, 무단 전재와 복사, 배포 등을 금합니다.