【マルチステージビルド】Go 言語で開発したプロダクトのイメージサイズを小さくする

$ git clone [email protected]:NaokiYazawa/multi-stage-build.git
$ cd multi-stage-build

$ touch .env

POSTGRES_USER=postgres
POSTGRES_PASSWORD=secret
POSTGRES_DB=mydb
POSTGRES_HOST=postgres
DB_PORT=5432

$ docker-compose up

api         |
api         |    ____    __
api         |   / __/___/ /  ___
api         |  / _// __/ _ \/ _ \
api         | /___/\__/_//_/\___/ v3.3.10-dev
api         | High performance, minimalist Go web framework
api         | https://echo.labstack.com
api         | ____________________________________O/_______
api         |                                     O\
api         | ⇨ http server started on [::]:8080

$ make create_user
# curl -X POST "http://localhost:8080/users" -H  "accept: application/json" -H  "Content-Type: application/json" -d "{\"name\":\"Jack\"}"
# {"id":1,"name":"Jack"}

$ make get_users
# curl -X GET "http://localhost:8080/users" -H  "accept: application/json"
# [{"id":1,"name":"Jack"}]

$ make get_user
# curl -X GET "http://localhost:8080/users/1" -H  "accept: application/json"
# {"id":1,"name":"Jack"}

$ make update_user
# curl -X PUT "http://localhost:8080/users/1" -H  "accept: application/json" -H  "Content-Type: application/json" -d "{\"name\":\"updated-Jack\"}"
# {"id":1,"name":"updated-Jack"}

$ make delete_user
# curl -X DELETE "http://localhost:8080/users/1" -H  "accept: application/json" -H  "Content-Type: application/json

####################### Build stage #######################
# golang:<version>-alpine は、Alpine Linux プロジェクトをベースにしている。
# イメージサイズを最小にするため、git、gcc、bash などは、Alpine-based のイメージには含まれていない。
FROM golang:1.16-alpine3.13 AS builder
# 作業ディレクトリの定義をする。今回は、app ディレクトリとした。
WORKDIR /app
# go.mod と go.sum を app ディレクトリにコピー
COPY go.mod go.sum ./
# 指定されたモジュールをダウンロードする。
RUN go mod download
# ルートディレクトリの中身を app フォルダにコピーする
COPY . .
# 実行ファイルの作成
# -o はアウトプットの名前を指定。
# ビルドするファイル名を指定（今回は main.go）。
RUN go build -o main /app/main.go


####################### Run stage #######################
# Goで作成したバイナリは Alpine Linux 上で動く。
# alpineLinux とは軽量でセキュアな Linux であり、とにかく軽量。
FROM alpine:3.13
# 作業ディレクトリの定義
WORKDIR /app
# Build stage からビルドされた main だけを Run stage にコピーする。（重要）
COPY --from=builder /app/main .
# ローカルの .env と .wait-for.sh をコンテナ側の app フォルダにコピーする
COPY .env .
COPY wait-for.sh .
# wait-for.sh の権限を変更
# x ･･･ 実行権限
RUN chmod +x wait-for.sh
# EXPOSE 命令は、実際にポートを公開するわけではない。
# これは、イメージを構築する人とコンテナを実行する人の間で、どのポートを公開するかについての一種の文書として機能する。
# 今回、docker-compose.yml において、api コンテナは 8080 ポートを解放するため「8080」とする。
EXPOSE 8080
# バイナリファイルの実行
CMD [ "/app/main" ]

FROM golang:1.16-alpine3.13 AS builder

FROM alpine:3.13

RUN go build -o main /app/main.go

# Build stage からビルドされた main だけを Run stage にコピーする。
COPY --from=builder /app/main .

FROM golang:1.16-alpine3.13 AS builder

$ docker iamges

REPOSITORY              TAG       IMAGE ID       CREATED        SIZE
multi-stage-build_api   latest    b1fa72be0f91   3 hours ago    20.6MB
postgres                12.8      108ccc7c5fa3   6 months ago   371MB

$ docker-compose down

$ docker images

$ docker rmi -f <IMAGE ID>

# Build stage
# golang:<version>-alpine は、Alpine Linux プロジェクトをベースにしている。
# イメージサイズを最小にするため、git、gcc、bash などは、Alpine-based のイメージには含まれていない。
FROM golang:1.16-alpine3.13 AS builder
# 作業ディレクトリの定義をする。今回は、app ディレクトリとした。
WORKDIR /app
# go.mod と go.sum を app ディレクトリにコピー
COPY go.mod go.sum ./
# 指定されたモジュールをダウンロードする。
RUN go mod download
# src ディレクトリの中身を app フォルダにコピーする
COPY . .
# 実行ファイルの作成
# -o はアウトプットの名前を指定。
# ビルドするファイル名を指定（今回は main.go）。
RUN go build -o main /app/main.go
# wait-for.sh の権限を変更
# x ･･･ 実行権限
RUN chmod +x wait-for.sh
# EXPOSE 命令は、実際にポートを公開するわけではない。
# これは、イメージを構築する人とコンテナを実行する人の間で、どのポートを公開するかについての一種の文書として機能する。
# 今回、docker-compose.yml において、api コンテナは 8080 ポートを解放するため「8080」とする。
EXPOSE 8080
# バイナリファイルの実行
CMD [ "/app/main" ]

$ docker-compose up 

REPOSITORY              TAG       IMAGE ID       CREATED         SIZE
multi-stage-build_api   latest    9c21dc557a66   9 seconds ago   446MB
postgres                12.8      108ccc7c5fa3   6 months ago    371MB

version: "3.8"

services:
  postgres:
    # コンテナ名を指定
    container_name: postgres
    image: postgres:12.8
    # OSの起動時にコンテナを起動させる
    restart: always
    env_file:
      - .env
    environment:
      - POSTGRES_USER=${POSTGRES_USER}
      - POSTGRES_PASSWORD=${POSTGRES_PASSWORD}
      - POSTGRES_DB=${POSTGRES_DB}
    ports:
      - 5432:5432
    volumes:
      - db:/var/lib/postgresql/data
  api:
    # コンテナ名を指定
    container_name: api
    build:
      # 「.」は本docker-compose.ymlがあるディレクトリ（現在のディレクトリ）を指す
      # 今回は、Dockerfile をルートディレクトリに配置する
      context: .
      dockerfile: Dockerfile
    ports:
      - "8080:8080"
    environment:
      POSTGRES_HOST: "${POSTGRES_HOST}"
    # depends_on は起動順を制御するだけである。
    # したがって、postgres コンテナが起動してから api コンテナが起動するという保証はされない
    depends_on:
      - postgres
    # entrypoint を設定すると、Dockerfile の ENTRYPOINT で設定されたデフォルトのエントリポイントが上書きされ、イメージのデフォルトコマンドがクリアされる。
    # つまり、Dockerfile に CMD 命令があれば、それは無視される。
    # よって、docker-compose.yml においても実行するコマンドを明示的に指定する必要がある。
    entrypoint: ["/app/wait-for.sh", "postgres:5432", "--"]
    command: ["/app/main"]

volumes:
  db: