docker-compose와 cmake

목표

 

디렉토리 구조

project
    - client
        - Dockerfile
        - CMakeLists.txt
        - src
            - ...
	- server
        - Dockerfile
        - CMakeLists.txt
        - src
            - ...
    - common
        - Dockerfile
        - CMakeLists.txt
        - src
            - ...
    - CMakeLists.txt
    - Docker-compose.txt

나의 프로젝트에는 크게 3개의 디렉토리가 존재한다.

 

나의 목표는 이와 같다.

구조를 각각 CMake를 통해 서로를 연결하고 docker-compose를 통해서 각각 컨테이너를 통해 통신이 되도록 만들 예정이다.

 

client

- docker container

- clinet에서 common 연동 사용

 

server

- docker container

- server에서 common 연동 사용

 

common

- client와 server에서 중복으로 사용될 함수들을 client와 server에서 include를 통해 사용할 수 있는 함수들을 담을 디렉토리

 

---

CMake 연결

main/CMakeLists.txt

# main/CMakeLists.txt
cmake_minimum_required(VERSION 3.29)
project(TransFile_TCP)

set(CMAKE_CXX_STANDARD 14)

add_subdirectory(common)
add_subdirectory(server)
add_subdirectory(client)

• 전체적인 CmakeLists.txt 들을 관리할 Root CmakeLists.txt 파일을 생성한다.

 

common/CMakeList.txt

# common/CMakeList.txt
cmake_minimum_required(VERSION 3.29)

project(common)

add_library(common STATIC
        src/network_utils.cpp
)
target_include_directories(common PUBLIC ${CMAKE_CURRENT_SOURCE_DIR}/src)

• add_libraty : common 라는 이름을 가진 정적라이브러리 생성한다.
• target_include_directories(PUBLIC) : 해당 타겟뿐만 아니라, 해당 타겟을 링크하는 외부 타겟에도 필요한 경우에 사용
  위와 같은 경우 common을 다른 (ex: server, clinet) 라이브러리에서 사용할 수 있도록 PUBLIC으로 생성을 진행한다.

server/CMakeLists.txt

# server/CMakeList.txt
cmake_minimum_required(VERSION 3.29)

project(server)

add_executable(server
        src/server.cpp
)

# common 헤더 파일 경로 추가
target_include_directories(server PRIVATE ${CMAKE_SOURCE_DIR}/common)
# common 라이브러리 링크
target_link_libraries(server PRIVATE common)

• target_include_directories(PRIVATE) : 해당 타겟에서만 필요한 헤더 파일 경로이거나 라이브러리일 때 사용
  server에 경우에는 추가적인 공유를 안해도 되기때문에 PRIVATE으로 생성
• target_link_libraries : 다른 다이브러리와 실질적으로 링크를 해주기위해 사용한다.
  server와 common 서로 링크

차이점 요약

명령어	목적	타겟에 대한 영향	주로 사용하는 시점
target_include_directories	헤더 파일 경로 추가 (컴파일러가 참조할 수 있도록)	타겟의 소스 파일에서 헤더를 포함할 수 있게 됨	컴파일 단계에서 헤더 파일을 찾을 때 사용
target_link_libraries	라이브러리 링크 (기계어 코드 연결)	타겟이 실제로 사용할 라이브러리의 코드를 포함시킴	링크 단계에서 라이브러리 코드를 연결할 때 사용

 

 

client/CMakeLists.txt

# client/CMakeList.txt
cmake_minimum_required(VERSION 3.29)

project(client)

add_executable(client
        src/client.cpp
)

# common 헤더 파일 경로 추가
target_include_directories(client PRIVATE ${CMAKE_SOURCE_DIR}/common)
# common 라이브러리 링크
target_link_libraries(client PRIVATE common)

• server와 이하동문

 

---

dockerfile

docker-compose.yaml

services:
  cmake-build:
    image: cmake-build
    container_name: cmake-build
    build:
      context: .
      dockerfile: cmake-build/Dockerfile
    volumes:
      - ./common:/app/common
      - ./server:/app/server
      - ./client:/app/client

  common:
    image: common
    container_name: common
    build:
      context: .
      dockerfile: common/Dockerfile
    depends_on:
      - cmake-build
    volumes:
      - ./common:/app/common

  server:
    image: server
    container_name: server
    build:
      context: .
      dockerfile: server/Dockerfile
    ports:
      - "8080:8080"
    depends_on:
      - cmake-build
    volumes:
      - ./server:/app/server
      - ./common:/app/common

  client:
    image: client
    container_name: client
    build:
      context: .
      dockerfile: client/Dockerfile
    depends_on:
      - cmake-build
    volumes:
      - ./client:/app/client
      - ./common:/app/common

• services : build, common, server, client 총 4개 존재

 

cmake-build/Dockerfile

# cmake-build/Dockerfile
FROM alpine:latest

# 공통 빌드 툴 설치
RUN apk update && apk add --no-cache \
    build-base \
    cmake \
    g++ \
    && rm -rf /var/cache/apk/*

WORKDIR /app
COPY . /app

RUN rm -rf build && mkdir -p build && cd build && \
    cmake .. && \
    make

• servcie마다 빌드 툴들 설치 및 cmake 작업을 진행하면 메모리 소모 및 시간적으로 손해가 크기때문에 전반적인 작업을 진행해줄 img를 생성

 

common/Dockerfile

# common/Dockerfile
FROM cmake-build

WORKDIR /app
COPY . /app

• cmake-build 기반의 build를 사용 (그로인해 추가적인 설치 필요 X)
• common에 경우에는 server와 client에게 코드를 전달해주는 역할이기때문에 따로 CMD 동작 X

 

server/Dockerfile

# server/Dockerfile
FROM cmake-build

COPY ./ /app
WORKDIR /app

CMD ["/app/build/server/server"]

• cmake-build 기반의 build를 사용 (그로인해 추가적인 설치 필요 X)
• 전체적인 코드를 복사하여 container 안으로 넣어주고 CMD를 통해 server 실행

 

client/Dockerfile

# client/Dockerfile
FROM cmake-build

# 클라이언트 소스 복사
COPY ./ /app
WORKDIR /app

# 클라이언트 실행
CMD ["/app/build/client/client"]

• server와 이하동문

 

---

필요한 수정사항

• 현재의 CMake로 인해 생성된 build 파일들은 cmake-build 안에서 만들어진다.
  그렇게 떄문에 cmake-build 컨테이너가 내려가면 build 관련 파일들도 volumes를 할 수 없게된다.
  이럴 경우 어떻게 build관련파일들을 volumes하여 관찰할것인가?