[docker] aihubshell Docker 구축 및 자동화

개요

개발 배경

Windows 환경에서의 문제

1. 바이너리 실행 불가: aihubshell이 Linux 바이너리로만 제공됨.

2. 의존성 문제: Windows에서는 필요한 패키지를 설치하기 어려움.

3. 환경 차이: aihubshell의 사용 환경이 제한적이므로, Windows 사용자가 별도로 Linux 환경을 구축해야 함.

Docker 이미지 설계

Dockerfile 구성

FROM alpine:latest

RUN apk update && apk add --no-cache curl unzip gcompat bash

RUN curl -o "aihubshell" https://api.aihub.or.kr/api/`aihubshell`.do \
    && chmod +x `aihubshell` \
    && cp `aihubshell` /usr/bin

RUN echo '#!/bin/sh' > /usr/local/bin/startup.sh && \
    echo 'echo "************************************************"' >> /usr/local/bin/startup.sh && \
    echo 'echo "*  UNOFFICIAL AIHUBSHELL IMAGE                 *"' >> /usr/local/bin/startup.sh && \
    echo 'echo "*  NO WARRANTIES OR LEGAL LIABILITY PROVIDED.  *"' >> /usr/local/bin/startup.sh && \
    echo 'echo "*  USE AT YOUR OWN RISK.                       *"' >> /usr/local/bin/startup.sh && \
    echo 'echo "************************************************"' >> /usr/local/bin/startup.sh && \
    echo 'exec "$@"' >> /usr/local/bin/startup.sh

RUN chmod +x /usr/local/bin/startup.sh

WORKDIR /data

ENTRYPOINT ["/usr/local/bin/startup.sh"]

1. 최소한의 패키지 설치: apk add를 통해 curl, unzip, bash 등의 필수 패키지만 추가.

2. aihubshll 설치: curl을 이용해 바이너리를 다운로드하고 실행 권한을 부여.

3. 시작 메시지 제공: 컨테이너 실행 시 사용자에게 경고 메시지를 출력.

4. 작업 디렉토리 설정: /data를 기본 작업 디렉토리로 설정하여 데이터 저장을 용이하게 함.

자동 배포 및 관리

deploy.yml 상세 분석

name: Build and Push Docker Image
on:
  push:
    branches:
      - main
    paths:
      - 'Dockerfile'
      - '.github/workflows/deploy.yml'
  schedule:
    - cron: '0 0 * * 1'
  workflow_dispatch:

• 자동화된 트리거 설정: main 브랜치의 Dockerfile이나 deploy.yml이 변경될 경우 자동으로 빌드가 실행된다.

• 주간 빌드: 매주 월요일 00:00(UTC) 기준으로 자동 업데이트되어 최신 상태를 유지한다.

• 수동 실행 지원: 필요할 경우 개발자가 직접 워크플로우를 실행할 수 있도록 workflow_dispatch를 추가했다.

permissions:
  packages: write
  id-token: write
  contents: write
  actions: write

• 권한 관리: GHCR(GitHub Container Registry)에 이미지를 푸시하기 위해 packages: write 권한을 부여했다.

• 보안 고려: ID 토큰과 콘텐츠 수정 권한을 추가해 안정적인 빌드 환경을 보장했다.

jobs:
  build-and-release:
    runs-on: ubuntu-latest
    steps:

• 빌드 환경 지정: ubuntu-latest에서 실행되도록 설정하여 최신 도구를 활용할 수 있도록 했다.

• 멀티플랫폼 지원: linux/amd64, linux/arm64 등의 아키텍처를 지원하여 호환성을 극대화했다.

- name: Create Release
  env:
    GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
  run: |
    RELEASE_TYPE="주간 릴리스"
    if [[ "${{ github.event_name }}" == "push" ]]; then
      RELEASE_TYPE="패치 릴리스"
    fi
    RELEASE_NOTES="Docker 이미지: 최신 버전 업데이트"
    gh release create "${{ env.version }}" --generate-notes --title "$RELEASE_TYPE ${{ env.version }}" --notes "$RELEASE_NOTES" --draft=false --prerelease=false

• 자동 릴리즈 생성: GitHub Release를 통해 빌드된 Docker 이미지의 새로운 버전을 자동으로 릴리즈하도록 설정했다.

• 주간 릴리즈와 패치 릴리즈 구분: push 이벤트인지 schedule 이벤트인지에 따라 릴리즈 유형을 다르게 설정했다.

결론