Web開発において複数人で同じ環境を用意しよう(Dockerの基本)

この記事ではDockerの基本を記述する．Dockerを用いるとWeb開発において非常に便利である．

開発するときあるある

私個人の主観ですが，経験談でこのようなことがあった．

複数人で開発するとき...こんなことありませんか？

そもそも同じPCで開発すればいいが...そんなわけにもいかないだろう．ならば違うPCでも同じような環境で動かせばいいだろう．それでも同じPCでもさまざまなアプリを開発しているから，他のパッケージ，フレームワーク，ライブラリが邪魔しないだろうか？

Web開発においてこんなことありませんか？

個人開発では作成するソフトウェアのパッケージ，フレームワーク，ライブラリのバージョンが今までインストールされていたバージョンと一致しないことがあるだろう．

共同開発ではチームメンバーでパッケージ，フレームワーク，ライブラリのバージョンを合わせたり，各々で個別にインストールすることが大変だろう．

Dockerの概要

アプリケーションをコンテナという隔離された環境にパッケージ化するためのオープンソースのプラットフォーム．
開発，デプロイ，実行が簡単にできるようになる．

Dockerを使うメリット

環境一貫性とポータビリティ
Docker コンテナはアプリケーションとその依存関係を一つのパッケージにカプセル化する．これにより，開発，テスト，本番環境間での「動作するはずが動かない」という問題を解決する．また，Docker コンテナはどのプラットフォーム（Linux, Windows, macOSなど）でも実行できる．

開発の効率化
Dockerを使用することで，必要な環境をすぐに用意できる．また、再利用，配布をすれば，開発プロセスの効率化につながる．Dockerはマイクロサービスアーキテクチャの採用を助ける．各マイクロサービスを個別のコンテナとして分離・運用することが容易になる．

インフラストラクチャの最適化
Docker コンテナは軽量で，起動が速く，少ないリソースで多くのコンテナを同時に実行できる．これにより，ハードウェアリソースをより効率的に使用できる．Docker コンテナは簡単にスケールアップおよびスケールダウンが可能．クラウド環境やオーケストレーションツール（Kubernetesなど）と組み合わせることで、自動スケーリングやロードバランシングが容易になる．

Dockerを使う上での用語説明

Docker Container(コンテナ)

Docker Containerとは，アプリケーションとその実行に必要なすべての依存関係を含む軽量な，スタンドアローンの実行可能パッケージ．Docker コンテナは，Docker エンジンがインストールされた任意のシステム上で動作するように設計されており，これをコンテナ仮想化技術という

コンテナ仮想化技術と仮想環境の違い
従来の仮想マシン（VM）よりも効率的にシステムリソースを利用する．VMがハードウェアレベルの仮想化を提供するのに対し，コンテナはオペレーティングシステムレベルの仮想化を提供する．これにより，コンテナは軽量で，起動が速く，少ないリソースで多くのコンテナを実行できる．

詳しくは以下の記事で説明している．
https://qiita.com/tarakokko3233/items/aa732d049d16e50f5d07

つまり，分かりやすく言うと以下の画像のようになる．

ある入れ物(コンテナ)の中に
OS
依存関係
ミドルウェア
アプリケーション
が入っており，これでアプリケーション単位での依存関係(パッケージ，フレームワーク，ライブラリ)の管理が可能になる．

これを他の人でも共有して開発できれば簡単に共同開発できる

Docker Image(イメージ)

Docker イメージは，Docker コンテナを実行するための静的なテンプレート．これは，コンテナを実行する際に必要なすべてのファイル，コード，ライブラリ，環境設定，および依存関係が含まれている．これを実行すると，コンテナが形成される．

Dockerイメージを生成するためにDockerfileを作成する．これはDocker イメージの設計図となる．

Dockerfileの作成例

まず雛形を提示する

# ベースイメージの指定
FROM python:3.8

# 環境変数の設定
ENV PYTHONDONTWRITEBYTECODE 1
ENV PYTHONUNBUFFERED 1

# 作業ディレクトリの設定
WORKDIR /code

# 依存関係ファイルのコピー
COPY requirements.txt /code/

# 依存関係のインストール
RUN pip install -r requirements.txt

# アプリケーションのソースコードをコピー
COPY . /code/

# アプリケーションの起動コマンド
CMD ["python", "app.py"]

FROM
どのイメージを基にするかを定義する．実行するためのプログラミング言語，パッケージなどのバージョンと合わせて記述する．

ENV
環境変数を設定する

WORKDIR
コンテナ内の作業ディレクトリを設定．名前はなんでもいいがこの例では/codeを使っている．このディレクトリにさまざまなファイルを追加していく．

COPY
requirements.txtを先ほど作成した /code/ディレクトリに追加する．

pythonでは依存関係のリストをrequirements.txtに格納する．
また，. /code/でカレントディレクトリにあるすべてのソースコードを /code/ディレクトリに追加する．

RUN
必要なパッケージやソフトウェアをインストールする．この例ではrequirements.txtにリストされたPythonパッケージをインストールしている．

pythonではpip nstall -r requirements.txtでrequirements.txtに書かれた依存関係のリストをまとめてインストールできる．

EXPOSE
コンテナがリッスンするポートを指定できる．

CMD
コンテナが起動時に実行するデフォルトのコマンドを設定する．

pythonではpython app.pyで実行する

このようにして作成したDockerfileをビルドすることでDocker イメージができる．

Docker Volume(ボリューム)

データを保存し永続化するための場所．コンテナは通常，削除されるとその内部で作成されたファイルも失われる．しかし，ボリュームを使用すると，これらのデータをコンテナのライフサイクルとは独立して保存できる．

複数のコンテナを組み合わせるには

複数のコンテナを組み合わせて使用することは非常に一般的であり，Dockerの主要な利用シナリオの一つである．特に，マイクロサービスアーキテクチャの実装や，異なるサービスが連携して動作するアプリケーションを開発する場合に有効である．例えばアプリケーションが二つ以上あるときや，データベースと組み合わせたい時に使われる．
複数のコンテナやボリュームなどを組み合わせるならばdocker-compose.ymlを作成する．

dockerイメージが1つしか定義していない場合もぜひdocker-compose.ymlを作成してほしい．servicesに定義するコンテナを1つにすればいい．

docker-compose.yml

version: '3.8'

services:
  app:
    build: .
    ports:
      - "5000:5000"
    volumes:
      - .:/code
    depends_on:
      - db
  db:
    image: postgres:12
    environment:
      POSTGRES_DB: exampledb
      POSTGRES_USER: user
      POSTGRES_PASSWORD: password
    volumes:
      - db-data:/var/lib/postgresql/data

volumes:
  db-data:

networks:
  app-network:
    driver: bridge

Dockerfileを明示的に指定しなくてもよい，通常はbuildで指定したディレクトリのルートにあるDockerfileを探すが，Dockerfile以外のファイル名を使用する場合は以下のようにあるサービス内に指定する必要がある．

dockerfile: Dockerfile.custom

docker-compose.ymlの中身の説明

services
管理する全てのサービス（コンテナ）の定義を始めることを示す．

appサービスについて

app
これはコンテナ名．なんでもいい．

build: .
build キーはDockerfileのあるディレクトリのパスを指定する．ここでは、カレントディレクトリ（.）が指定されている．

ports: - "5000:5000"
ポートの指定．

volumes: - .:/code
はホストのディレクトリとコンテナ内のディレクトリをマッピングするために使用する．ここでは，カレントディレクトリがコンテナの /code ディレクトリにマップされている．

depends_on: - db
appが db に依存していることを示す．これにより，dbが先に起動する．

dbサービスについて

db
これはコンテナ名．なんでもいい．

image
使用するDockerイメージを指定する．これはデータベース用にDockerfileを作成してその中に書いても良いが，docker-compose.ymlの中に記述しても良い．

environment
データベースの名前，ユーザー名，パスワードといった環境変数を設定．

volumes: - db-data:/var/lib/postgresql/data
データベースのデータをホストの db-data ボリュームに保存する．

ボリューム設定

volumes: db-data:
データベースのデータを永続化するためのボリュームを定義．

ネットワーク設定

networks: app-network: driver: bridge
Composeファイルで定義されるネットワークの設定．ここでは app-network がブリッジドライバを使用して定義されている．これにより，app と dbが同じネットワーク内で通信することが可能になる．

これによりコンテナを連携させられる

Dockerでよく使うコマンド集

docker composeの実行方法などdockerでよく使うコマンド集をリストアップしたので参考にしてほしい．本記事で作成したdockerイメージを実行するためには以下の記事から．

DockerDesktopアプリで大体のことはできるが，コマンドの方が早く実行できる場合がある．